From 665d02780ca1efd4d53bcac2cb38f4b7da1cd1b6 Mon Sep 17 00:00:00 2001 From: Justin Ma Date: Wed, 18 Sep 2024 16:56:10 +0800 Subject: [PATCH] Refresh command docs for Nu 0.98.0 (#1555) * Refresh command docs for Nu 0.98.0 * Refresh command docs for Nu 0.98.0 * Refresh command docs for Nu 0.98.0 --- .../configs/sidebar/command_categories.ts | 1 - 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 | 2 +- commands/docs/ast.md | 2 +- commands/docs/bits.md | 4 +- commands/docs/bits_and.md | 2 +- commands/docs/bits_not.md | 2 +- commands/docs/bits_or.md | 2 +- commands/docs/bits_rol.md | 2 +- commands/docs/bits_ror.md | 2 +- commands/docs/bits_shl.md | 2 +- commands/docs/bits_shr.md | 2 +- commands/docs/bits_xor.md | 2 +- commands/docs/break.md | 2 +- commands/docs/bytes.md | 4 +- commands/docs/bytes_add.md | 2 +- 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 | 2 +- commands/docs/bytes_length.md | 2 +- commands/docs/bytes_remove.md | 2 +- commands/docs/bytes_replace.md | 2 +- commands/docs/bytes_reverse.md | 2 +- commands/docs/bytes_starts-with.md | 2 +- commands/docs/cal.md | 2 +- commands/docs/cd.md | 2 +- commands/docs/char.md | 2 +- commands/docs/chunks.md | 2 +- commands/docs/clear.md | 11 +-- commands/docs/collect.md | 2 +- commands/docs/columns.md | 2 +- commands/docs/commandline.md | 4 +- commands/docs/commandline_edit.md | 2 +- commands/docs/commandline_get-cursor.md | 2 +- commands/docs/commandline_set-cursor.md | 2 +- commands/docs/compact.md | 2 +- commands/docs/complete.md | 2 +- commands/docs/config.md | 4 +- commands/docs/config_env.md | 2 +- commands/docs/config_nu.md | 2 +- commands/docs/config_reset.md | 2 +- commands/docs/const.md | 2 +- commands/docs/continue.md | 2 +- commands/docs/cp.md | 2 +- commands/docs/date.md | 4 +- 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 | 2 +- commands/docs/debug.md | 4 +- commands/docs/debug_info.md | 2 +- commands/docs/debug_profile.md | 2 +- commands/docs/decode.md | 13 ++-- commands/docs/decode_base32.md | 59 ++++++++++++++++ commands/docs/decode_base32hex.md | 59 ++++++++++++++++ commands/docs/decode_base64.md | 2 +- commands/docs/decode_hex.md | 34 ++++------ commands/docs/decode_new-base64.md | 60 ++++++++++++++++ commands/docs/def.md | 2 +- commands/docs/default.md | 2 +- commands/docs/describe.md | 4 +- commands/docs/detect_columns.md | 2 +- commands/docs/dexit.md | 2 +- commands/docs/do.md | 2 +- commands/docs/drop.md | 4 +- commands/docs/drop_column.md | 2 +- commands/docs/drop_nth.md | 2 +- commands/docs/du.md | 2 +- commands/docs/each.md | 4 +- commands/docs/each_while.md | 2 +- commands/docs/echo.md | 2 +- commands/docs/encode.md | 13 ++-- commands/docs/encode_base32.md | 55 +++++++++++++++ commands/docs/encode_base32hex.md | 55 +++++++++++++++ commands/docs/encode_base64.md | 2 +- commands/docs/encode_hex.md | 42 +++++++----- commands/docs/encode_new-base64.md | 56 +++++++++++++++ commands/docs/enter.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 | 2 +- commands/docs/explore.md | 2 +- commands/docs/export-env.md | 2 +- commands/docs/export.md | 4 +- commands/docs/export_alias.md | 2 +- commands/docs/export_const.md | 2 +- commands/docs/export_def.md | 2 +- commands/docs/export_extern.md | 2 +- commands/docs/export_module.md | 2 +- commands/docs/export_use.md | 2 +- commands/docs/extern.md | 2 +- commands/docs/fill.md | 2 +- commands/docs/filter.md | 2 +- commands/docs/find.md | 2 +- commands/docs/first.md | 2 +- commands/docs/flatten.md | 2 +- commands/docs/fmt.md | 2 +- commands/docs/for.md | 2 +- commands/docs/format.md | 4 +- commands/docs/format_date.md | 2 +- commands/docs/format_duration.md | 2 +- commands/docs/format_filesize.md | 2 +- commands/docs/format_pattern.md | 2 +- commands/docs/from.md | 4 +- commands/docs/from_csv.md | 2 +- commands/docs/from_eml.md | 2 +- commands/docs/from_ics.md | 2 +- commands/docs/from_ini.md | 2 +- commands/docs/from_json.md | 2 +- commands/docs/from_msgpack.md | 2 +- commands/docs/from_msgpackz.md | 2 +- commands/docs/from_nuon.md | 2 +- commands/docs/from_ods.md | 2 +- commands/docs/from_plist.md | 2 +- commands/docs/from_ssv.md | 2 +- commands/docs/from_toml.md | 2 +- commands/docs/from_tsv.md | 2 +- commands/docs/from_url.md | 2 +- commands/docs/from_vcf.md | 2 +- commands/docs/from_xlsx.md | 2 +- commands/docs/from_xml.md | 2 +- commands/docs/from_yaml.md | 2 +- commands/docs/from_yml.md | 2 +- commands/docs/g.md | 2 +- commands/docs/generate.md | 2 +- commands/docs/get.md | 2 +- commands/docs/glob.md | 2 +- commands/docs/grid.md | 9 ++- commands/docs/group-by.md | 2 +- commands/docs/group.md | 2 +- commands/docs/gstat.md | 2 +- commands/docs/hash.md | 4 +- commands/docs/hash_md5.md | 2 +- commands/docs/hash_sha256.md | 2 +- commands/docs/headers.md | 2 +- commands/docs/help.md | 8 +-- commands/docs/help_aliases.md | 6 +- commands/docs/help_commands.md | 4 +- commands/docs/help_escapes.md | 2 +- commands/docs/help_externs.md | 6 +- commands/docs/help_modules.md | 6 +- commands/docs/help_operators.md | 2 +- commands/docs/hide-env.md | 2 +- commands/docs/hide.md | 2 +- commands/docs/histogram.md | 2 +- commands/docs/history.md | 4 +- commands/docs/history_session.md | 2 +- commands/docs/http.md | 4 +- 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 | 4 +- commands/docs/http_post.md | 4 +- commands/docs/http_put.md | 4 +- commands/docs/if.md | 2 +- commands/docs/ignore.md | 2 +- commands/docs/inc.md | 2 +- commands/docs/input.md | 4 +- commands/docs/input_list.md | 2 +- commands/docs/input_listen.md | 2 +- commands/docs/insert.md | 2 +- commands/docs/inspect.md | 2 +- commands/docs/interleave.md | 2 +- commands/docs/into.md | 4 +- commands/docs/into_binary.md | 2 +- commands/docs/into_bits.md | 2 +- commands/docs/into_bool.md | 2 +- commands/docs/into_cell-path.md | 2 +- commands/docs/into_datetime.md | 2 +- commands/docs/into_duration.md | 2 +- commands/docs/into_filesize.md | 2 +- commands/docs/into_float.md | 2 +- commands/docs/into_glob.md | 2 +- commands/docs/into_int.md | 2 +- commands/docs/into_record.md | 50 +++++++------- commands/docs/into_sqlite.md | 2 +- commands/docs/into_string.md | 2 +- commands/docs/into_value.md | 2 +- commands/docs/is-admin.md | 2 +- commands/docs/is-empty.md | 2 +- commands/docs/is-not-empty.md | 2 +- commands/docs/is-terminal.md | 2 +- commands/docs/items.md | 2 +- commands/docs/join.md | 2 +- commands/docs/keybindings.md | 4 +- 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/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 | 4 +- commands/docs/math_abs.md | 2 +- commands/docs/math_arccos.md | 2 +- commands/docs/math_arccosh.md | 2 +- commands/docs/math_arcsin.md | 2 +- commands/docs/math_arcsinh.md | 2 +- commands/docs/math_arctan.md | 2 +- commands/docs/math_arctanh.md | 2 +- commands/docs/math_avg.md | 2 +- commands/docs/math_ceil.md | 2 +- commands/docs/math_cos.md | 2 +- commands/docs/math_cosh.md | 2 +- commands/docs/math_exp.md | 2 +- commands/docs/math_floor.md | 2 +- commands/docs/math_ln.md | 2 +- commands/docs/math_log.md | 2 +- 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 | 2 +- commands/docs/math_sinh.md | 2 +- commands/docs/math_sqrt.md | 2 +- commands/docs/math_stddev.md | 2 +- commands/docs/math_sum.md | 2 +- commands/docs/math_tan.md | 2 +- commands/docs/math_tanh.md | 2 +- commands/docs/math_variance.md | 2 +- commands/docs/merge.md | 2 +- commands/docs/metadata.md | 9 +-- commands/docs/metadata_access.md | 43 ++++++++++++ commands/docs/metadata_set.md | 2 +- commands/docs/mkdir.md | 2 +- commands/docs/mktemp.md | 2 +- commands/docs/module.md | 2 +- commands/docs/move.md | 2 +- commands/docs/mut.md | 2 +- commands/docs/mv.md | 2 +- commands/docs/n.md | 2 +- commands/docs/nu-check.md | 2 +- commands/docs/nu-highlight.md | 2 +- commands/docs/open.md | 2 +- commands/docs/overlay.md | 4 +- 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/p.md | 2 +- commands/docs/panic.md | 30 +++++--- commands/docs/par-each.md | 2 +- commands/docs/parse.md | 2 +- commands/docs/path.md | 4 +- commands/docs/path_basename.md | 2 +- commands/docs/path_dirname.md | 2 +- commands/docs/path_exists.md | 5 +- commands/docs/path_expand.md | 2 +- commands/docs/path_join.md | 2 +- 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/plugin.md | 4 +- commands/docs/plugin_add.md | 2 +- commands/docs/plugin_list.md | 4 +- commands/docs/plugin_rm.md | 2 +- commands/docs/plugin_stop.md | 2 +- commands/docs/plugin_use.md | 2 +- commands/docs/polars.md | 14 ++-- commands/docs/polars_agg-groups.md | 31 +++++++-- commands/docs/polars_agg.md | 38 +++-------- commands/docs/polars_all-false.md | 2 +- commands/docs/polars_all-true.md | 2 +- commands/docs/polars_append.md | 2 +- commands/docs/polars_arg-max.md | 2 +- commands/docs/polars_arg-min.md | 2 +- commands/docs/polars_arg-sort.md | 2 +- commands/docs/polars_arg-true.md | 2 +- commands/docs/polars_arg-unique.md | 2 +- commands/docs/polars_arg-where.md | 2 +- commands/docs/polars_as-date.md | 2 +- commands/docs/polars_as-datetime.md | 2 +- commands/docs/polars_as.md | 2 +- commands/docs/polars_cache.md | 20 ++++-- commands/docs/polars_cast.md | 2 +- commands/docs/polars_col.md | 17 ++++- commands/docs/polars_collect.md | 2 +- commands/docs/polars_columns.md | 2 +- commands/docs/polars_concat-str.md | 2 +- commands/docs/polars_concatenate.md | 52 -------------- commands/docs/polars_contains.md | 17 ++++- commands/docs/polars_count-null.md | 2 +- commands/docs/polars_count.md | 25 ++++--- commands/docs/polars_cumulative.md | 28 ++++++-- commands/docs/polars_datepart.md | 2 +- commands/docs/polars_decimal.md | 49 +++++++++++++ commands/docs/polars_drop-duplicates.md | 10 +-- commands/docs/polars_drop-nulls.md | 2 +- commands/docs/polars_drop.md | 2 +- commands/docs/polars_dummies.md | 2 +- commands/docs/polars_explode.md | 8 ++- commands/docs/polars_expr-not.md | 28 ++++++-- commands/docs/polars_fetch.md | 2 +- commands/docs/polars_fill-nan.md | 2 +- commands/docs/polars_fill-null.md | 2 +- commands/docs/polars_filter-with.md | 2 +- commands/docs/polars_filter.md | 2 +- commands/docs/polars_first.md | 2 +- commands/docs/polars_flatten.md | 2 +- commands/docs/polars_get-day.md | 2 +- commands/docs/polars_get-hour.md | 2 +- commands/docs/polars_get-minute.md | 2 +- commands/docs/polars_get-month.md | 2 +- commands/docs/polars_get-nanosecond.md | 2 +- commands/docs/polars_get-ordinal.md | 2 +- commands/docs/polars_get-second.md | 2 +- commands/docs/polars_get-week.md | 2 +- commands/docs/polars_get-weekday.md | 2 +- commands/docs/polars_get-year.md | 2 +- commands/docs/polars_get.md | 2 +- commands/docs/polars_group-by.md | 22 +----- commands/docs/polars_implode.md | 27 +++++--- commands/docs/polars_integer.md | 45 ++++++++++++ commands/docs/polars_into-df.md | 2 +- commands/docs/polars_into-lazy.md | 2 +- commands/docs/polars_into-nu.md | 2 +- commands/docs/polars_is-duplicated.md | 2 +- commands/docs/polars_is-in.md | 2 +- commands/docs/polars_is-not-null.md | 2 +- commands/docs/polars_is-null.md | 2 +- commands/docs/polars_is-unique.md | 2 +- commands/docs/polars_join.md | 2 +- commands/docs/polars_last.md | 2 +- commands/docs/polars_lit.md | 2 +- commands/docs/polars_lowercase.md | 13 +++- commands/docs/polars_max.md | 16 +++-- commands/docs/polars_mean.md | 16 +++-- commands/docs/polars_median.md | 12 ++-- commands/docs/polars_min.md | 16 +++-- commands/docs/polars_n-unique.md | 2 +- commands/docs/polars_not.md | 2 +- commands/docs/polars_open.md | 2 +- commands/docs/polars_otherwise.md | 2 +- commands/docs/polars_pivot.md | 2 +- commands/docs/polars_quantile.md | 10 +-- commands/docs/polars_query.md | 2 +- commands/docs/polars_rename.md | 2 +- commands/docs/polars_replace-all.md | 15 +++- commands/docs/polars_replace.md | 14 +++- commands/docs/polars_reverse.md | 8 +-- commands/docs/polars_rolling.md | 2 +- commands/docs/polars_sample.md | 2 +- commands/docs/polars_save.md | 2 +- commands/docs/polars_schema.md | 2 +- commands/docs/polars_select.md | 2 +- commands/docs/polars_set-with-idx.md | 2 +- commands/docs/polars_set.md | 2 +- commands/docs/polars_shape.md | 2 +- commands/docs/polars_shift.md | 2 +- commands/docs/polars_slice.md | 2 +- commands/docs/polars_sort-by.md | 2 +- commands/docs/polars_std.md | 18 ++--- commands/docs/polars_store-get.md | 2 +- commands/docs/polars_store-ls.md | 2 +- commands/docs/polars_store-rm.md | 2 +- commands/docs/polars_str-join.md | 68 +++++++++++++++++++ commands/docs/polars_str-lengths.md | 19 +++++- commands/docs/polars_str-slice.md | 15 +++- commands/docs/polars_strftime.md | 16 ++++- commands/docs/polars_sum.md | 18 ++--- commands/docs/polars_summary.md | 2 +- commands/docs/polars_take.md | 2 +- commands/docs/polars_unique.md | 2 +- commands/docs/polars_unpivot.md | 2 +- commands/docs/polars_uppercase.md | 13 +++- commands/docs/polars_value-counts.md | 8 +-- commands/docs/polars_var.md | 18 ++--- commands/docs/polars_when.md | 2 +- commands/docs/polars_with-column.md | 2 +- commands/docs/port.md | 2 +- commands/docs/prepend.md | 2 +- commands/docs/print.md | 2 +- commands/docs/ps.md | 2 +- commands/docs/pwd.md | 2 +- commands/docs/query.md | 4 +- commands/docs/query_db.md | 2 +- commands/docs/query_json.md | 2 +- commands/docs/query_web.md | 2 +- commands/docs/query_webpage-info.md | 2 +- commands/docs/query_xml.md | 2 +- commands/docs/random.md | 4 +- commands/docs/random_binary.md | 2 +- commands/docs/random_bool.md | 2 +- commands/docs/random_chars.md | 2 +- commands/docs/random_dice.md | 2 +- commands/docs/random_float.md | 2 +- commands/docs/random_int.md | 2 +- commands/docs/random_uuid.md | 2 +- commands/docs/range.md | 2 +- commands/docs/reduce.md | 2 +- commands/docs/registry_query.md | 2 +- commands/docs/reject.md | 2 +- commands/docs/rename.md | 2 +- commands/docs/return.md | 2 +- commands/docs/reverse.md | 2 +- commands/docs/rm.md | 2 +- commands/docs/roll.md | 4 +- 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 | 4 +- 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 | 4 +- commands/docs/seq_char.md | 2 +- commands/docs/seq_date.md | 2 +- commands/docs/shells.md | 2 +- commands/docs/shuffle.md | 2 +- commands/docs/skip.md | 4 +- commands/docs/skip_until.md | 2 +- commands/docs/skip_while.md | 2 +- commands/docs/sleep.md | 2 +- commands/docs/sort-by.md | 2 +- commands/docs/sort.md | 2 +- commands/docs/source-env.md | 2 +- commands/docs/source.md | 2 +- commands/docs/split-by.md | 2 +- commands/docs/split.md | 17 ++--- commands/docs/split_cell-path.md | 55 +++++++++++++++ commands/docs/split_chars.md | 2 +- commands/docs/split_column.md | 15 +++- commands/docs/split_list.md | 2 +- commands/docs/split_row.md | 2 +- commands/docs/split_words.md | 2 +- commands/docs/start.md | 2 +- commands/docs/stor.md | 4 +- commands/docs/stor_create.md | 2 +- commands/docs/stor_delete.md | 2 +- commands/docs/stor_export.md | 2 +- commands/docs/stor_import.md | 2 +- commands/docs/stor_insert.md | 2 +- commands/docs/stor_open.md | 2 +- commands/docs/stor_reset.md | 2 +- commands/docs/stor_update.md | 2 +- commands/docs/str.md | 5 +- commands/docs/str_camel-case.md | 2 +- commands/docs/str_capitalize.md | 2 +- commands/docs/str_contains.md | 2 +- commands/docs/str_deunicode.md | 34 ---------- 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 | 2 +- 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_stats.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 | 4 +- commands/docs/sys_cpu.md | 2 +- commands/docs/sys_disks.md | 2 +- commands/docs/sys_host.md | 2 +- commands/docs/sys_mem.md | 2 +- commands/docs/sys_net.md | 2 +- commands/docs/sys_temp.md | 2 +- commands/docs/sys_users.md | 2 +- commands/docs/table.md | 2 +- commands/docs/take.md | 4 +- commands/docs/take_until.md | 2 +- commands/docs/take_while.md | 2 +- commands/docs/tee.md | 8 ++- commands/docs/term_size.md | 2 +- commands/docs/timeit.md | 2 +- commands/docs/to.md | 4 +- commands/docs/to_csv.md | 2 +- commands/docs/to_html.md | 2 +- commands/docs/to_json.md | 2 +- commands/docs/to_md.md | 2 +- commands/docs/to_msgpack.md | 2 +- commands/docs/to_msgpackz.md | 2 +- commands/docs/to_nuon.md | 2 +- commands/docs/to_plist.md | 2 +- commands/docs/to_text.md | 2 +- commands/docs/to_toml.md | 2 +- commands/docs/to_tsv.md | 2 +- commands/docs/to_xml.md | 2 +- commands/docs/to_yaml.md | 2 +- commands/docs/touch.md | 2 +- commands/docs/transpose.md | 2 +- commands/docs/try.md | 16 ++--- commands/docs/tutor.md | 2 +- commands/docs/ulimit.md | 2 +- commands/docs/uname.md | 2 +- commands/docs/uniq-by.md | 2 +- commands/docs/uniq.md | 2 +- commands/docs/update.md | 4 +- commands/docs/update_cells.md | 2 +- commands/docs/upsert.md | 2 +- commands/docs/url.md | 4 +- commands/docs/url_build-query.md | 2 +- commands/docs/url_decode.md | 2 +- commands/docs/url_encode.md | 2 +- commands/docs/url_join.md | 2 +- commands/docs/url_parse.md | 2 +- commands/docs/use.md | 2 +- commands/docs/values.md | 2 +- commands/docs/version.md | 2 +- commands/docs/view.md | 4 +- commands/docs/view_files.md | 2 +- commands/docs/view_ir.md | 2 +- commands/docs/view_source.md | 2 +- commands/docs/view_span.md | 2 +- commands/docs/watch.md | 2 +- commands/docs/where.md | 2 +- commands/docs/which.md | 2 +- commands/docs/while.md | 2 +- commands/docs/whoami.md | 2 +- commands/docs/window.md | 2 +- commands/docs/with-env.md | 2 +- commands/docs/wrap.md | 2 +- commands/docs/zip.md | 2 +- 555 files changed, 1673 insertions(+), 917 deletions(-) create mode 100644 commands/docs/decode_base32.md create mode 100644 commands/docs/decode_base32hex.md create mode 100644 commands/docs/decode_new-base64.md create mode 100644 commands/docs/encode_base32.md create mode 100644 commands/docs/encode_base32hex.md create mode 100644 commands/docs/encode_new-base64.md create mode 100644 commands/docs/metadata_access.md delete mode 100644 commands/docs/polars_concatenate.md create mode 100644 commands/docs/polars_decimal.md create mode 100644 commands/docs/polars_integer.md create mode 100644 commands/docs/polars_str-join.md create mode 100644 commands/docs/split_cell-path.md delete mode 100644 commands/docs/str_deunicode.md diff --git a/.vuepress/configs/sidebar/command_categories.ts b/.vuepress/configs/sidebar/command_categories.ts index 8ec58438f5d..b396886c265 100644 --- a/.vuepress/configs/sidebar/command_categories.ts +++ b/.vuepress/configs/sidebar/command_categories.ts @@ -11,7 +11,6 @@ export const commandCategories = [ '/commands/categories/debug.md', '/commands/categories/default.md', '/commands/categories/env.md', - '/commands/categories/experimental.md', '/commands/categories/expression.md', '/commands/categories/filesystem.md', '/commands/categories/filters.md', diff --git a/commands/docs/alias.md b/commands/docs/alias.md index 7eb533a7308..ac113343a25 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.97.1 +version: 0.98.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 749c1cd0ff3..14ac5782c0d 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.97.1 +version: 0.98.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 9775897f760..aedd2c4af9e 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Output ANSI codes to change color and style of text. usage: | @@ -142,7 +142,7 @@ Operating system commands: ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------- | ------------------------------------------------------------------ | -------- | | [`ansi gradient`](/commands/docs/ansi_gradient.md) | Add a color gradient (using ANSI color codes) to the given string. | built-in | | [`ansi link`](/commands/docs/ansi_link.md) | Add a link (using OSC 8 escape sequence) to the given string. | built-in | diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index e1676757705..9e025ba9282 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.97.1 +version: 0.98.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 44102049267..87350575e19 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.97.1 +version: 0.98.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 78f54a753f8..d27761f8521 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index 81518ce0541..f185403c3a2 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.97.1 +version: 0.98.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 5ae300044b5..c13be8168cf 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index bb541d4c797..43c80273a7f 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/bits.md b/commands/docs/bits.md index acb0bb58adc..11a9ff532e0 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Various commands for working with bits. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------- | ----------------------------------------------- | -------- | | [`bits and`](/commands/docs/bits_and.md) | Performs bitwise and for ints or binary values. | built-in | | [`bits not`](/commands/docs/bits_not.md) | Performs logical negation on each bit. | built-in | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index 37239d3f613..0e648817c2e 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Performs bitwise and for ints or binary values. usage: | diff --git a/commands/docs/bits_not.md b/commands/docs/bits_not.md index ce44abee0f0..41cbc7e042e 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index b99704da10a..c4719db1b12 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Performs bitwise or for ints or binary values. usage: | diff --git a/commands/docs/bits_rol.md b/commands/docs/bits_rol.md index 0b872c1e198..d36f3ae1874 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Bitwise rotate left for ints or binary values. usage: | diff --git a/commands/docs/bits_ror.md b/commands/docs/bits_ror.md index 3cf709e3a4f..d42d64f1a40 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Bitwise rotate right for ints or binary values. usage: | diff --git a/commands/docs/bits_shl.md b/commands/docs/bits_shl.md index 9e1ed00e4a7..87848ac7f99 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Bitwise shift left for ints or binary values. usage: | diff --git a/commands/docs/bits_shr.md b/commands/docs/bits_shr.md index 1f8d493d22a..fe41ad7da8f 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Bitwise shift right for ints or binary values. usage: | diff --git a/commands/docs/bits_xor.md b/commands/docs/bits_xor.md index 4f585e371ad..5b587198dec 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.97.1 +version: 0.98.0 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 0d4814cbbfc..0d96dfc1899 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.97.1 +version: 0.98.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 74eab4fb71e..67209f279d6 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.97.1 +version: 0.98.0 bytes: | Various commands for working with byte data. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------- | | [`bytes add`](/commands/docs/bytes_add.md) | Add specified bytes to the input. | built-in | | [`bytes at`](/commands/docs/bytes_at.md) | Get bytes defined by a range. | built-in | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index 963680ad115..3825238cd29 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.97.1 +version: 0.98.0 bytes: | Add specified bytes to the input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 4d4a48a646c..bee8e9ed504 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.97.1 +version: 0.98.0 bytes: | Get bytes defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 511daabccb4..13328191e4b 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.97.1 +version: 0.98.0 bytes: | Create bytes from the arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index c6a3d207ddd..c81322a8644 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.97.1 +version: 0.98.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 90cfb48aa19..c16cfdcf454 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.97.1 +version: 0.98.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 446a9235905..547d3a5c618 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.97.1 +version: 0.98.0 bytes: | Returns start index of first occurrence of pattern in bytes, or -1 if no match. usage: | diff --git a/commands/docs/bytes_length.md b/commands/docs/bytes_length.md index fd521bb2b2e..8746b6b33dd 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.97.1 +version: 0.98.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 26d84b73609..93bd69b8841 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.97.1 +version: 0.98.0 bytes: | Remove bytes. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 6d7712e480d..835cd836c5e 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.97.1 +version: 0.98.0 bytes: | Find and replace binary. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index 8ad498c1193..95c5b8a7729 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.97.1 +version: 0.98.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 383bfee9fbc..c9ba64b59d5 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.97.1 +version: 0.98.0 bytes: | Check if bytes starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 3a65badd449..b62adeba27a 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.97.1 +version: 0.98.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index d381a365e0d..f832e6e3d4e 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Change directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 6e1f994cc25..10dba031d10 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md index 37654f5e3db..f2dec1ed603 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Divide a list or table into chunks of `chunk_size`. usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 17b36846a69..1f90399ab64 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Clear the terminal. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--all, -a`: Clear the terminal and its scroll-back history + - `--keep-scrollback, -k`: Do not clear the scrollback history ## Input/output types: @@ -37,8 +37,11 @@ Clear the terminal ``` -Clear the terminal and its scroll-back history +Clear the terminal but not its scrollback history ```nu -> clear --all +> clear --keep-scrollback ``` + +## Notes +By default clears the current screen and the off-screen scrollback buffer. \ No newline at end of file diff --git a/commands/docs/collect.md b/commands/docs/collect.md index dbb7b5cba58..3a567fe75ff 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 87a77858cae..13d06d9d8ed 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.97.1 +version: 0.98.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 b416371f61a..6651b371b79 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.97.1 +version: 0.98.0 core: | View the current command line input buffer. usage: | @@ -28,7 +28,7 @@ usage: | ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------------------------- | --------------------------------------------- | -------- | | [`commandline edit`](/commands/docs/commandline_edit.md) | Modify the current command line input buffer. | built-in | | [`commandline get-cursor`](/commands/docs/commandline_get-cursor.md) | Get the current cursor position. | built-in | diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index b35077a955e..d1d79f5a585 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.97.1 +version: 0.98.0 core: | Modify the current command line input buffer. usage: | diff --git a/commands/docs/commandline_get-cursor.md b/commands/docs/commandline_get-cursor.md index 7aab1f6f1bc..d550993007b 100644 --- a/commands/docs/commandline_get-cursor.md +++ b/commands/docs/commandline_get-cursor.md @@ -2,7 +2,7 @@ title: commandline get-cursor categories: | core -version: 0.97.1 +version: 0.98.0 core: | Get the current cursor position. usage: | diff --git a/commands/docs/commandline_set-cursor.md b/commands/docs/commandline_set-cursor.md index 6d1144fba1a..eaf56dfea3f 100644 --- a/commands/docs/commandline_set-cursor.md +++ b/commands/docs/commandline_set-cursor.md @@ -2,7 +2,7 @@ title: commandline set-cursor categories: | core -version: 0.97.1 +version: 0.98.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 05bfeb032b4..26ac11d43ff 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 60d981b6a14..7520c47ce93 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.97.1 +version: 0.98.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 786e3dd2921..89ba6975988 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.97.1 +version: 0.98.0 env: | Edit nushell configuration files. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | -------- | | [`config env`](/commands/docs/config_env.md) | Edit nu environment configurations. | built-in | | [`config nu`](/commands/docs/config_nu.md) | Edit nu configurations. | built-in | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 9005802789f..a95d8bbe621 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.97.1 +version: 0.98.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index 8c3845ec03f..3f63c0b7e08 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.97.1 +version: 0.98.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 6ab0a7c4437..57eaba875f7 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.97.1 +version: 0.98.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 4da28e10056..c2186786503 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.97.1 +version: 0.98.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index 24a2afa7406..974bbc9ebb6 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.97.1 +version: 0.98.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 4a1ea1187ac..824fab24fb3 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index 1ad407a2ec2..f73bb869d63 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.97.1 +version: 0.98.0 date: | Date-related commands. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------------ | --------------------------------------------------------- | -------- | | [`date format`](/commands/docs/date_format.md) | Removed command: use `format date` instead. | built-in | | [`date humanize`](/commands/docs/date_humanize.md) | Print a 'humanized' format for the date, relative to now. | built-in | diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 4fb224116d4..ff5240c9785 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.97.1 +version: 0.98.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index ab9ba253d21..94ed71a78ee 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.97.1 +version: 0.98.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 e63b38e2611..a459272ed7a 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.97.1 +version: 0.98.0 date: | List supported time zones. usage: | diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index 799b4bf0208..47485acabbb 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.97.1 +version: 0.98.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-record.md b/commands/docs/date_to-record.md index d2640fe6bf3..c6189fc76e1 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.97.1 +version: 0.98.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 0bbabe8f996..c9d1bd34d1c 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.97.1 +version: 0.98.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 3001985e81d..dc1351de32b 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.97.1 +version: 0.98.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index 55d86ea0eb2..4358638841b 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Debug print the value(s) piped in. usage: | @@ -60,7 +60,7 @@ Debug print a table ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------- | --------------------------------------- | -------- | | [`debug info`](/commands/docs/debug_info.md) | View process memory info. | built-in | | [`debug profile`](/commands/docs/debug_profile.md) | Profile pipeline elements in a closure. | built-in | \ No newline at end of file diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 3c68ba3acd1..b4e7fbb9289 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 617b14723b7..15e70561fdd 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index 5cfe92f87e4..6ce6475d31c 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Decode bytes into a string. usage: | @@ -52,7 +52,10 @@ documentation link at https://docs.rs/encoding_rs/latest/encoding_rs/#statics ## Subcommands: -| name | usage | type | -| -------------------------------------------------- | ---------------------- | -------- | -| [`decode base64`](/commands/docs/decode_base64.md) | Base64 decode a value. | built-in | -| [`decode hex`](/commands/docs/decode_hex.md) | Hex decode a value. | built-in | \ No newline at end of file +| name | description | type | +| ---------------------------------------------------------- | ------------------------- | -------- | +| [`decode base32`](/commands/docs/decode_base32.md) | Decode a Base32 value. | built-in | +| [`decode base32hex`](/commands/docs/decode_base32hex.md) | Encode a base32hex value. | built-in | +| [`decode base64`](/commands/docs/decode_base64.md) | Base64 decode a value. | built-in | +| [`decode hex`](/commands/docs/decode_hex.md) | Hex decode a value. | built-in | +| [`decode new-base64`](/commands/docs/decode_new-base64.md) | Decode a Base64 value. | built-in | \ No newline at end of file diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md new file mode 100644 index 00000000000..69a221e56c1 --- /dev/null +++ b/commands/docs/decode_base32.md @@ -0,0 +1,59 @@ +--- +title: decode base32 +categories: | + formats +version: 0.98.0 +formats: | + Decode a Base32 value. +usage: | + Decode a Base32 value. +--- + + +# `decode base32` for [formats](/commands/categories/formats.md) + +
Decode a Base32 value.
+ +## Signature + +```> decode base32 {flags} ``` + +## Flags + + - `--nopad, -`: Do not pad the output. + + +## Input/output types: + +| input | output | +| ------ | ------ | +| string | binary | + +## Examples + +Decode arbitrary binary data +```nu +> "AEBAGBAF" | decode base32 +Length: 5 (0x5) bytes | printable whitespace ascii_other non_ascii +00000000: 01 02 03 04 05 ••••• + +``` + +Decode an encoded string +```nu +> "NBUQ====" | decode base32 | decode + +``` + +Parse a string without padding +```nu +> "NBUQ" | decode base32 --nopad +Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +00000000: 68 69 hi + +``` + +## Notes +The default alphabet is taken from RFC 4648, section 6. + +Note this command will collect stream input. \ No newline at end of file diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md new file mode 100644 index 00000000000..969cc33f782 --- /dev/null +++ b/commands/docs/decode_base32hex.md @@ -0,0 +1,59 @@ +--- +title: decode base32hex +categories: | + formats +version: 0.98.0 +formats: | + Encode a base32hex value. +usage: | + Encode a base32hex value. +--- + + +# `decode base32hex` for [formats](/commands/categories/formats.md) + +
Encode a base32hex value.
+ +## Signature + +```> decode base32hex {flags} ``` + +## Flags + + - `--nopad, -`: Reject input with padding. + + +## Input/output types: + +| input | output | +| ------ | ------ | +| string | binary | + +## Examples + +Decode arbitrary binary data +```nu +> "ATNAQ===" | decode base32hex +Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +00000000: 57 6e ad Wn× + +``` + +Decode an encoded string +```nu +> "D1KG====" | decode base32hex | decode + +``` + +Parse a string without padding +```nu +> "ATNAQ" | decode base32hex --nopad +Length: 3 (0x3) bytes | printable whitespace ascii_other non_ascii +00000000: 57 6e ad Wn× + +``` + +## Notes +This command uses an alternative Base32 alphabet, defined in RFC 4648, section 7. + +Note this command will collect stream input. \ No newline at end of file diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index b009de59ef6..4a4c06422c4 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | hash -version: 0.97.1 +version: 0.98.0 hash: | Base64 decode a value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index d45114c73bc..5101fe4ddac 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Hex decode a value. usage: | @@ -16,35 +16,29 @@ usage: | ## Signature -```> decode hex {flags} ...rest``` - -## Parameters - - - `...rest`: For a data structure input, decode data at the given cell paths +```> decode hex {flags} ``` ## Input/output types: -| input | output | -| ------------ | ------------ | -| list\ | list\ | -| record | record | -| string | binary | -| table | table | +| input | output | +| ------ | ------ | +| string | binary | + ## Examples -Hex decode a value and output as binary +Decode arbitrary binary data ```nu -> '0102030A0a0B' | decode hex -Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii -00000000: 01 02 03 0a 0a 0b •••__• +> "09FD" | decode hex +Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +00000000: 09 fd _× ``` -Whitespaces are allowed to be between hex digits +Lowercase Hex is also accepted ```nu -> '01 02 03 0A 0a 0B' | decode hex -Length: 6 (0x6) bytes | printable whitespace ascii_other non_ascii -00000000: 01 02 03 0a 0a 0b •••__• +> "09fd" | decode hex +Length: 2 (0x2) bytes | printable whitespace ascii_other non_ascii +00000000: 09 fd _× ``` diff --git a/commands/docs/decode_new-base64.md b/commands/docs/decode_new-base64.md new file mode 100644 index 00000000000..5a9929769a4 --- /dev/null +++ b/commands/docs/decode_new-base64.md @@ -0,0 +1,60 @@ +--- +title: decode new-base64 +categories: | + formats +version: 0.98.0 +formats: | + Decode a Base64 value. +usage: | + Decode a Base64 value. +--- + + +# `decode new-base64` for [formats](/commands/categories/formats.md) + +
Decode a Base64 value.
+ +## Signature + +```> decode new-base64 {flags} ``` + +## Flags + + - `--url, -`: Decode the URL-safe Base64 version. + - `--nopad, -`: Reject padding. + + +## Input/output types: + +| input | output | +| ------ | ------ | +| string | binary | + +## Examples + +Decode a Base64 string +```nu +> "U29tZSBEYXRh" | decode new-base64 | decode + +``` + +Decode arbitrary data +```nu +> "/w==" | decode new-base64 +Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii +00000000: ff × + +``` + +Decode a URL-safe Base64 string +```nu +> "_w==" | decode new-base64 --url +Length: 1 (0x1) bytes | printable whitespace ascii_other non_ascii +00000000: ff × + +``` + +## Notes +The default alphabet is taken from RFC 4648, section 4. A URL-safe version is available. + +Note this command will collect stream input. \ No newline at end of file diff --git a/commands/docs/def.md b/commands/docs/def.md index dae61404a31..c5da542d854 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.97.1 +version: 0.98.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index eebd1ccc7bf..2a3f8195cd9 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Sets a default value if a row's column is missing or null. usage: | diff --git a/commands/docs/describe.md b/commands/docs/describe.md index f1053892bcc..8752270d791 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.97.1 +version: 0.98.0 core: | Describe the type and structure of the value(s) piped in. usage: | @@ -40,7 +40,7 @@ string Describe the type of a record in a detailed way ```nu -> {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| print $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d +> {shell:'true', uwu:true, features: {bugs:false, multiplatform:true, speed: 10}, fib: [1 1 2 3 5 8], on_save: {|x| $'Saving ($x)'}, first_commit: 2019-05-10, my_duration: (4min + 20sec)} | describe -d ╭─────────┬───────────────────────────────────────────────────────────╮ │ type │ record │ │ │ ╭──────────────┬────────────────────────────────────────╮ │ diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index 9ead63a0938..ecce413ec97 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/dexit.md b/commands/docs/dexit.md index de8fe6e1b5e..561a5300cb1 100644 --- a/commands/docs/dexit.md +++ b/commands/docs/dexit.md @@ -2,7 +2,7 @@ title: dexit categories: | shells -version: 0.96.0 +version: 0.98.0 shells: | Leaves a previously entered working directory. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index 0b196ac4730..0ff2f17efcb 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.97.1 +version: 0.98.0 core: | Run a closure, providing it with the pipeline input. usage: | diff --git a/commands/docs/drop.md b/commands/docs/drop.md index 490cce17e25..6993af83aa5 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Remove items/rows from the end of the input list/table. Counterpart of `skip`. Opposite of `last`. usage: | @@ -78,7 +78,7 @@ Remove the last row in a table ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------- | -------- | | [`drop column`](/commands/docs/drop_column.md) | Remove N columns at the right-hand end of the input table. To remove columns by name, use `reject`. | built-in | | [`drop nth`](/commands/docs/drop_nth.md) | Drop the selected rows. | built-in | \ No newline at end of file diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index 3d6560dd90e..c87276e2787 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.97.1 +version: 0.98.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 598e9ee1427..d4033db56a2 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 86ddaac88b1..63be6029719 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index b7aec317e84..6eaf89de8db 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -99,6 +99,6 @@ with 'transpose' first. ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -------- | | [`each while`](/commands/docs/each_while.md) | Run a closure on each row of the input list until a null is found, then create a new list with the results. | built-in | diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 6281bdd7749..ce9ab4d9fe9 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Run a closure on each row of the input list until a null is found, then create a new list with the results. usage: | diff --git a/commands/docs/echo.md b/commands/docs/echo.md index b94d408bad2..29264496069 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.97.1 +version: 0.98.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index fa1a92d3e8e..131c4730776 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Encode a string into bytes. usage: | @@ -65,7 +65,10 @@ documentation link at https://docs.rs/encoding_rs/latest/encoding_rs/#statics ## Subcommands: -| name | usage | type | -| -------------------------------------------------- | --------------------------------------------- | -------- | -| [`encode base64`](/commands/docs/encode_base64.md) | Encode a string or binary value using Base64. | built-in | -| [`encode hex`](/commands/docs/encode_hex.md) | Encode a binary value using hex. | built-in | \ No newline at end of file +| name | description | type | +| ---------------------------------------------------------- | -------------------------------------------------- | -------- | +| [`encode base32`](/commands/docs/encode_base32.md) | Encode a string or binary value using Base32. | built-in | +| [`encode base32hex`](/commands/docs/encode_base32hex.md) | Encode a binary value or a string using base32hex. | built-in | +| [`encode base64`](/commands/docs/encode_base64.md) | Encode a string or binary value using Base64. | built-in | +| [`encode hex`](/commands/docs/encode_hex.md) | Hex encode a binary value or a string. | built-in | +| [`encode new-base64`](/commands/docs/encode_new-base64.md) | Encode a string or binary value using Base64. | built-in | \ No newline at end of file diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md new file mode 100644 index 00000000000..60a2cf20c02 --- /dev/null +++ b/commands/docs/encode_base32.md @@ -0,0 +1,55 @@ +--- +title: encode base32 +categories: | + formats +version: 0.98.0 +formats: | + Encode a string or binary value using Base32. +usage: | + Encode a string or binary value using Base32. +--- + + +# `encode base32` for [formats](/commands/categories/formats.md) + +
Encode a string or binary value using Base32.
+ +## Signature + +```> encode base32 {flags} ``` + +## Flags + + - `--nopad, -`: Don't accept padding. + + +## Input/output types: + +| input | output | +| ------ | ------ | +| binary | string | +| string | string | +## Examples + +Encode a binary value +```nu +> 0x[01 02 10] | encode base32 +AEBBA=== +``` + +Encode a string +```nu +> "hello there" | encode base32 +NBSWY3DPEB2GQZLSMU====== +``` + +Don't apply padding to the output +```nu +> "hi" | encode base32 --nopad +NBUQ +``` + +## Notes +The default alphabet is taken from RFC 4648, section 6. + +Note this command will collect stream input. \ No newline at end of file diff --git a/commands/docs/encode_base32hex.md b/commands/docs/encode_base32hex.md new file mode 100644 index 00000000000..63126c475c4 --- /dev/null +++ b/commands/docs/encode_base32hex.md @@ -0,0 +1,55 @@ +--- +title: encode base32hex +categories: | + formats +version: 0.98.0 +formats: | + Encode a binary value or a string using base32hex. +usage: | + Encode a binary value or a string using base32hex. +--- + + +# `encode base32hex` for [formats](/commands/categories/formats.md) + +
Encode a binary value or a string using base32hex.
+ +## Signature + +```> encode base32hex {flags} ``` + +## Flags + + - `--nopad, -`: Don't pad the output. + + +## Input/output types: + +| input | output | +| ------ | ------ | +| binary | string | +| string | string | +## Examples + +Encode a binary value +```nu +> 0x[57 6E AD] | encode base32hex +ATNAQ=== +``` + +Encode a string +```nu +> "hello there" | encode base32hex +D1IMOR3F41Q6GPBICK====== +``` + +Don't apply padding to the output +```nu +> "hello there" | encode base32hex --nopad +D1IMOR3F41Q6GPBICK +``` + +## Notes +This command uses an alternative Base32 alphabet, defined in RFC 4648, section 7. + +Note this command will collect stream input. \ No newline at end of file diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index bfb65c99b9d..84c73a31b86 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | hash -version: 0.97.1 +version: 0.98.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 eed4c0eb443..d270dd3a574 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,39 +2,49 @@ title: encode hex categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | - Encode a binary value using hex. + Hex encode a binary value or a string. usage: | - Encode a binary value using hex. + Hex encode a binary value or a string. --- # `encode hex` for [formats](/commands/categories/formats.md) -
Encode a binary value using hex.
+
Hex encode a binary value or a string.
## Signature -```> encode hex {flags} ...rest``` +```> encode hex {flags} ``` -## Parameters +## Flags - - `...rest`: For a data structure input, encode data at the given cell paths + - `--lower, -`: Encode to lowercase hex. ## Input/output types: -| input | output | -| ------------ | ------------ | -| binary | string | -| list\ | list\ | -| record | record | -| table | table | +| input | output | +| ------ | ------ | +| binary | string | +| string | string | ## Examples -Encode binary data +Encode a binary value ```nu -> 0x[09 F9 11 02 9D 74 E3 5B D8 41 56 C5 63 56 88 C0] | encode hex -09F911029D74E35BD84156C5635688C0 +> 0x[C3 06] | encode hex +C306 +``` + +Encode a string +```nu +> "hello" | encode hex +68656C6C6F +``` + +Output a Lowercase version of the encoding +```nu +> 0x[AD EF] | encode hex --lower +adef ``` diff --git a/commands/docs/encode_new-base64.md b/commands/docs/encode_new-base64.md new file mode 100644 index 00000000000..8aa44483e62 --- /dev/null +++ b/commands/docs/encode_new-base64.md @@ -0,0 +1,56 @@ +--- +title: encode new-base64 +categories: | + formats +version: 0.98.0 +formats: | + Encode a string or binary value using Base64. +usage: | + Encode a string or binary value using Base64. +--- + + +# `encode new-base64` for [formats](/commands/categories/formats.md) + +
Encode a string or binary value using Base64.
+ +## Signature + +```> encode new-base64 {flags} ``` + +## Flags + + - `--url, -`: Use the URL-safe Base64 version. + - `--nopad, -`: Don't pad the output. + + +## Input/output types: + +| input | output | +| ------ | ------ | +| binary | string | +| string | string | +## Examples + +Encode a string with Base64 +```nu +> "Alphabet from A to Z" | encode new-base64 +QWxwaGFiZXQgZnJvbSBBIHRvIFo= +``` + +Encode arbitrary data +```nu +> 0x[BE EE FF] | encode new-base64 +vu7/ +``` + +Use a URL-safe alphabet +```nu +> 0x[BE EE FF] | encode new-base64 --url +vu7_ +``` + +## Notes +The default alphabet is taken from RFC 4648, section 4. A URL-safe version is available. + +Note this command will collect stream input. \ No newline at end of file diff --git a/commands/docs/enter.md b/commands/docs/enter.md index 9945f670092..094895f7b7f 100644 --- a/commands/docs/enter.md +++ b/commands/docs/enter.md @@ -2,7 +2,7 @@ title: enter categories: | shells -version: 0.96.0 +version: 0.98.0 shells: | Enters a new shell at the given path. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 8ac73fd6a1c..7ec93cde8f7 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 90c1b2e46e6..9216ce57651 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.97.1 +version: 0.98.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index efaf87e5ddd..fb5d4335f0c 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.97.1 +version: 0.98.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 99e0ee14dbb..39d42cced51 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.97.1 +version: 0.98.0 system: | Execute a command, replacing or exiting the current process, depending on platform. usage: | diff --git a/commands/docs/exit.md b/commands/docs/exit.md index 2c6f8d1e68f..67f7aac4781 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.97.1 +version: 0.98.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index 743c53ea4a4..ec541499efa 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index 205754cbb46..4ef7a784526 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.97.1 +version: 0.98.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 4034c905b3d..f0d4c968835 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.97.1 +version: 0.98.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 c30d5d8f80c..ac47e356681 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.97.1 +version: 0.98.0 core: | Export definitions or environment variables from a module. usage: | @@ -39,7 +39,7 @@ This command is a parser keyword. For details, check: ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------- | -------------------------------------------------------------------------------- | ------- | | [`export alias`](/commands/docs/export_alias.md) | Alias a command (with optional flags) to a new name and export it from a module. | keyword | | [`export const`](/commands/docs/export_const.md) | Use parse-time constant from a module and export them from this module. | keyword | diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index 42ab3ebadb9..0cf78364592 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.97.1 +version: 0.98.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 3e5ecd76c16..1a7f0acdd80 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.97.1 +version: 0.98.0 core: | Use parse-time constant from a module and export them from this module. usage: | diff --git a/commands/docs/export_def.md b/commands/docs/export_def.md index c35cc0578ed..01673996ba7 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.97.1 +version: 0.98.0 core: | Define a custom command and export it from a module. usage: | diff --git a/commands/docs/export_extern.md b/commands/docs/export_extern.md index cc725bbc981..ce16df12b4e 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.97.1 +version: 0.98.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 c224d8de655..f098937c391 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.97.1 +version: 0.98.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 ea1fa0bf7f0..fc1a301a880 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.97.1 +version: 0.98.0 core: | Use definitions from a module and export them from this module. usage: | diff --git a/commands/docs/extern.md b/commands/docs/extern.md index 464e735a70f..c7573b8be00 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.97.1 +version: 0.98.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index 3355b171fd2..2070a2e5fdd 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Fill and Align. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 829fedc9f76..07ff413ba7c 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index ddb527656e6..1957f5d6c42 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Searches terms in the input. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index 97cc65f21e6..1719da6920d 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.97.1 +version: 0.98.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 3c84475af61..d99e1d209b6 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Flatten the table. usage: | diff --git a/commands/docs/fmt.md b/commands/docs/fmt.md index deb8fbf99d4..e363538dd42 100644 --- a/commands/docs/fmt.md +++ b/commands/docs/fmt.md @@ -2,7 +2,7 @@ title: fmt categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Format a number. usage: | diff --git a/commands/docs/for.md b/commands/docs/for.md index b0983366361..c1376b489ec 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.97.1 +version: 0.98.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index ab7dad9898f..c469e6b81ba 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Various commands for formatting data. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------ | -------------------------------------------------------- | -------- | | [`format date`](/commands/docs/format_date.md) | Format a given date using a format string. | built-in | | [`format duration`](/commands/docs/format_duration.md) | Outputs duration with a specified unit of time. | built-in | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index db36a4a95ce..45a94200794 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Format a given date using a format string. usage: | diff --git a/commands/docs/format_duration.md b/commands/docs/format_duration.md index 90866e6dfcc..c4e4745d21f 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.97.1 +version: 0.98.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 f679fe89b28..6d65de31b6f 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Converts a column of filesizes to some specified format. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 13e9548beec..71fd6197bd5 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Format columns into a string using a simple pattern. usage: | diff --git a/commands/docs/from.md b/commands/docs/from.md index 082b8d68277..f823c88bfff 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse a string or binary data into structured data. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------- | | [`from csv`](/commands/docs/from_csv.md) | Parse text as .csv and create table. | built-in | | [`from eml`](/commands/docs/from_eml.md) | Parse text as .eml and create record. | plugin | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index fb6f9611770..e6372419764 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.97.1 +version: 0.98.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 4b72b8defc1..baa391e8f77 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as .eml and create record. usage: | diff --git a/commands/docs/from_ics.md b/commands/docs/from_ics.md index eb6636edec3..402502d612a 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as .ics and create table. usage: | diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 2b8d53d5219..310a5a756da 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as .ini and create table. usage: | diff --git a/commands/docs/from_json.md b/commands/docs/from_json.md index 1fd36098936..70063473cdc 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert from json to structured data. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index 7b21daa62ea..c9bbb104944 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index 5896b0af17a..86682298232 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert brotli-compressed MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_nuon.md b/commands/docs/from_nuon.md index 52b9875fd5f..0d06d1a5fbe 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index 709e8e5780a..d789e987b49 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse OpenDocument Spreadsheet(.ods) data and create table. usage: | diff --git a/commands/docs/from_plist.md b/commands/docs/from_plist.md index a837b269562..eab17c076eb 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert plist to Nushell values usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 6e80d26f711..4b6b293feee 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. usage: | diff --git a/commands/docs/from_toml.md b/commands/docs/from_toml.md index 210e3977cdc..35d94659c51 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.97.1 +version: 0.98.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 9ae6d4bd749..f964921b8ef 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as .tsv and create table. usage: | diff --git a/commands/docs/from_url.md b/commands/docs/from_url.md index 04ff16709f1..2ab02e3665a 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.97.1 +version: 0.98.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 1339f789235..bf975d1a9fb 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as .vcf and create table. usage: | diff --git a/commands/docs/from_xlsx.md b/commands/docs/from_xlsx.md index 1ae7bf97253..e8a49dadd07 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse binary Excel(.xlsx) data and create table. usage: | diff --git a/commands/docs/from_xml.md b/commands/docs/from_xml.md index a833c0e2516..b824ccffabe 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.97.1 +version: 0.98.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 8748eba4ada..d317d8af804 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.97.1 +version: 0.98.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 a005042bce7..0413f04186c 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/g.md b/commands/docs/g.md index 5fe6141c90d..62cade0faa6 100644 --- a/commands/docs/g.md +++ b/commands/docs/g.md @@ -2,7 +2,7 @@ title: g categories: | shells -version: 0.96.0 +version: 0.98.0 shells: | Switch to a given shell, or list all shells if no given shell number. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index e3737459bf4..f2b6de30e27 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.97.1 +version: 0.98.0 generators: | Generate a list of values by successively invoking a closure. usage: | diff --git a/commands/docs/get.md b/commands/docs/get.md index 1d021909b02..1e8e7897aca 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 979b2de6807..69d7bc31c04 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Creates a list of files and/or folders based on the glob pattern provided. usage: | diff --git a/commands/docs/grid.md b/commands/docs/grid.md index 63aaef35a78..59040230801 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.97.1 +version: 0.98.0 viewers: | Renders the output to a textual terminal grid. usage: | @@ -22,6 +22,7 @@ usage: | - `--width, -w {int}`: number of terminal columns wide (not output columns) - `--color, -c`: draw output with color + - `--icons, -i`: draw output with icons (assumes nerd font is used) - `--separator, -s {string}`: character to separate grid with @@ -68,6 +69,12 @@ Render a table with 'name' column in it to a grid ``` +Render a table with 'name' column in it to a grid with icons and colors +```nu +> [[name patch]; [Cargo.toml false] [README.md true] [SECURITY.md false]] | grid --icons --color + +``` + ## Notes grid was built to give a concise gridded layout for ls. however, it determines what to put in the grid by looking for a column named diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index eaf576a8905..f791c002096 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.97.1 +version: 0.98.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 81e144f25e3..1885b016f52 100644 --- a/commands/docs/group.md +++ b/commands/docs/group.md @@ -2,7 +2,7 @@ title: group categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Groups input into groups of `group_size`. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 80b04b9a1f3..28cd339fe67 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.97.1 +version: 0.98.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index d4d2a032f62..20a79e8305a 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.97.1 +version: 0.98.0 hash: | Apply hash function. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------- | --------------------------------------------- | -------- | | [`hash md5`](/commands/docs/hash_md5.md) | Hash a value using the md5 hash algorithm. | built-in | | [`hash sha256`](/commands/docs/hash_sha256.md) | Hash a value using the sha256 hash algorithm. | built-in | \ No newline at end of file diff --git a/commands/docs/hash_md5.md b/commands/docs/hash_md5.md index d6d3be94b4a..6bbd18a7c2a 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.97.1 +version: 0.98.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 6110ae3be6a..a7c72b2db54 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.97.1 +version: 0.98.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 99814def474..e64d6c39fb3 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.97.1 +version: 0.98.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 3a9a12fd494..05443cf60c6 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.97.1 +version: 0.98.0 core: | Display help information about different parts of Nushell. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--find, -f {string}`: string to find in command names, usage, and search terms + - `--find, -f {string}`: string to find in command names, descriptions, and search terms ## Parameters @@ -47,7 +47,7 @@ show help for single sub-command, alias, or module ``` -search for string in command names, usage and search terms +search for string in command names, descriptions, and search terms ```nu > help --find char @@ -58,7 +58,7 @@ search for string in command names, usage and search terms ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------------- | ------------------------------------ | -------- | | [`help aliases`](/commands/docs/help_aliases.md) | Show help on nushell aliases. | built-in | | [`help commands`](/commands/docs/help_commands.md) | Show help on nushell commands. | built-in | diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index acffbeca135..6df005a39a8 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.97.1 +version: 0.98.0 core: | Show help on nushell aliases. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--find, -f {string}`: string to find in alias names and usage + - `--find, -f {string}`: string to find in alias names and descriptions ## Parameters @@ -47,7 +47,7 @@ show help for single alias ``` -search for string in alias names and usages +search for string in alias names and descriptions ```nu > help aliases --find my-alias diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 3aa460e07bf..c70cc8def34 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.97.1 +version: 0.98.0 core: | Show help on nushell commands. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--find, -f {string}`: string to find in command names, usage, and search terms + - `--find, -f {string}`: string to find in command names, descriptions, and search terms ## Parameters diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 11ce10919a7..31cf0136be0 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.97.1 +version: 0.98.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 76f149b23d8..adcc97d1321 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.97.1 +version: 0.98.0 core: | Show help on nushell externs. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--find, -f {string}`: string to find in extern names and usage + - `--find, -f {string}`: string to find in extern names and descriptions ## Parameters @@ -47,7 +47,7 @@ show help for single extern ``` -search for string in extern names and usages +search for string in extern names and descriptions ```nu > help externs --find smth diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index c0257441225..4b371757b18 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.97.1 +version: 0.98.0 core: | Show help on nushell modules. usage: | @@ -20,7 +20,7 @@ usage: | ## Flags - - `--find, -f {string}`: string to find in module names and usage + - `--find, -f {string}`: string to find in module names and descriptions ## Parameters @@ -47,7 +47,7 @@ show help for single module ``` -search for string in module names and usages +search for string in module names and descriptions ```nu > help modules --find my-module diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index a62c7cafe7e..82288edc0aa 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.97.1 +version: 0.98.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index 428ff07f107..f631c879b7d 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.97.1 +version: 0.98.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 22f782926e1..2741686f180 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.97.1 +version: 0.98.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index a4ba7e284b0..93fa48c8233 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.97.1 +version: 0.98.0 chart: | Creates a new table with a histogram based on the column name passed in. usage: | diff --git a/commands/docs/history.md b/commands/docs/history.md index b7eb8f5fd4f..aa7ea911122 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.97.1 +version: 0.98.0 history: | Get the command history. usage: | @@ -53,6 +53,6 @@ Search all the commands from history that contains 'cargo' ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------ | -------------------------------- | -------- | | [`history session`](/commands/docs/history_session.md) | Get the command history session. | built-in | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index c7c70c23f32..5ac7369cef3 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.97.1 +version: 0.98.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index 608c188ac7e..97241c9c003 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.97.1 +version: 0.98.0 network: | Various commands for working with http methods. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------ | --------------------------------------------------------- | -------- | | [`http delete`](/commands/docs/http_delete.md) | Delete the specified resource. | built-in | | [`http get`](/commands/docs/http_get.md) | Fetch the contents from a URL. | built-in | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 4d82f4aff7c..9d35fc85275 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.97.1 +version: 0.98.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index 54837dc4979..3ef7cef8664 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.97.1 +version: 0.98.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index 379d306fbf9..24531f9dcf4 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.97.1 +version: 0.98.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 0170719d52a..7f1d8be935a 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.97.1 +version: 0.98.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 2fda1a35fca..378afe3e008 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.97.1 +version: 0.98.0 network: | Patch a body to a URL. usage: | @@ -71,7 +71,7 @@ Patch content to example.com, with JSON body Patch JSON content from a pipeline to example.com ```nu -> open foo.json | http patch https://www.example.com +> open --raw foo.json | http patch https://www.example.com ``` diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index ee90bfca5fa..c09815b20fc 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.97.1 +version: 0.98.0 network: | Post a body to a URL. usage: | @@ -71,7 +71,7 @@ Post content to example.com, with JSON body Post JSON content from a pipeline to example.com ```nu -> open foo.json | http post https://www.example.com +> open --raw foo.json | http post https://www.example.com ``` diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 9fe0eed54a6..9c9d7541cfc 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.97.1 +version: 0.98.0 network: | Put a body to a URL. usage: | @@ -71,7 +71,7 @@ Put content to example.com, with JSON body Put JSON content from a pipeline to example.com ```nu -> open foo.json | http put https://www.example.com +> open --raw foo.json | http put https://www.example.com ``` diff --git a/commands/docs/if.md b/commands/docs/if.md index 4eb9a73438f..40609aec630 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.97.1 +version: 0.98.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index 112ff7ca140..95e32d15d75 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.97.1 +version: 0.98.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 44d6d2e812a..7428f223330 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.97.1 +version: 0.98.0 default: | Increment a value or version. Optionally use the column of a table. usage: | diff --git a/commands/docs/input.md b/commands/docs/input.md index 1eb3acae532..e3b130050d0 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Get input from the user. usage: | @@ -52,7 +52,7 @@ Get two characters from the user, and assign to a variable ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------ | -------------------------------- | -------- | | [`input list`](/commands/docs/input_list.md) | Interactive list selection. | built-in | | [`input listen`](/commands/docs/input_listen.md) | Listen for user interface event. | built-in | \ No newline at end of file diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index 3037ccd5c69..1f63848c749 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Interactive list selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index d88f6c8a103..bc2645375ff 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Listen for user interface event. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 2cbbb85f74c..97f0a991d09 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.97.1 +version: 0.98.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 b14884696b8..9bf25d75c4c 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index c1be8d5b6b8..82359fd3943 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Read multiple streams in parallel and combine them into one stream. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index 9e2eeb36cd3..7b8fb7ef5ec 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Commands to convert data from one type to another. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------------- | ------------------------------------------ | -------- | | [`into binary`](/commands/docs/into_binary.md) | Convert value to a binary primitive. | built-in | | [`into bits`](/commands/docs/into_bits.md) | Convert value to a binary primitive. | built-in | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 254169f00e8..e06205de42a 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bits.md b/commands/docs/into_bits.md index b0d86fd721b..0415f1a8804 100644 --- a/commands/docs/into_bits.md +++ b/commands/docs/into_bits.md @@ -2,7 +2,7 @@ title: into bits categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 627b7889604..abdfc4d19b5 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index a999d92db8f..00cab44f297 100644 --- a/commands/docs/into_cell-path.md +++ b/commands/docs/into_cell-path.md @@ -2,7 +2,7 @@ title: into cell-path categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index daf90b848b0..2edd273ebdc 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert text or timestamp into a datetime. usage: | diff --git a/commands/docs/into_duration.md b/commands/docs/into_duration.md index f270185f058..9107b8ef33e 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index bc868646d0e..13ca04a351b 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index fc3a3b5343e..085dda070ee 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index 6d80e1dd90e..f9fec744582 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to glob. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index a3753f84b74..d62351a93cd 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to integer. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index b87150535d8..b1c44d1a765 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to record. usage: | @@ -26,7 +26,6 @@ usage: | | datetime | record | | duration | record | | list\ | record | -| range | record | | record | record | ## Examples @@ -38,24 +37,22 @@ Convert from one row table to record ╰───────┴───────╯ ``` -Convert from list to record +Convert from list of records to record ```nu -> [1 2 3] | into record -╭───┬───╮ -│ 0 │ 1 │ -│ 1 │ 2 │ -│ 2 │ 3 │ -╰───┴───╯ +> [{foo: bar} {baz: quux}] | into record +╭─────┬──────╮ +│ foo │ bar │ +│ baz │ quux │ +╰─────┴──────╯ ``` -Convert from range to record +Convert from list of pairs into record ```nu -> 0..2 | into record -╭───┬───╮ -│ 0 │ 0 │ -│ 1 │ 1 │ -│ 2 │ 2 │ -╰───┴───╯ +> [[foo bar] [baz quux]] | into record +╭─────┬──────╮ +│ foo │ bar │ +│ baz │ quux │ +╰─────┴──────╯ ``` convert duration to record (weeks max) @@ -82,13 +79,16 @@ convert record to record convert date to record ```nu > 2020-04-12T22:10:57+02:00 | into record -╭──────────┬────────╮ -│ year │ 2020 │ -│ month │ 4 │ -│ day │ 12 │ -│ hour │ 22 │ -│ minute │ 10 │ -│ second │ 57 │ -│ timezone │ +02:00 │ -╰──────────┴────────╯ +╭─────────────┬────────╮ +│ year │ 2020 │ +│ month │ 4 │ +│ day │ 12 │ +│ hour │ 22 │ +│ minute │ 10 │ +│ second │ 57 │ +│ millisecond │ 0 │ +│ microsecond │ 0 │ +│ nanosecond │ 0 │ +│ timezone │ +02:00 │ +╰─────────────┴────────╯ ``` diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 288afbbd9ea..88168243315 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 6c27f10372b..e3157be5078 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.97.1 +version: 0.98.0 conversions: | Convert value to string. usage: | diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index a745258ca59..4b51f5c2b26 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Infer nushell datatype for each cell. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index 84269037717..5752da71131 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.97.1 +version: 0.98.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 55f3a47abcc..086dfc5fad5 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index cd2a34fcd61..8df3704777d 100644 --- a/commands/docs/is-not-empty.md +++ b/commands/docs/is-not-empty.md @@ -2,7 +2,7 @@ title: is-not-empty categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 34d34b610aa..41744c4cb27 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Check if stdin, stdout, or stderr is a terminal. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index 8fcb973b44d..b57afd04912 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.97.1 +version: 0.98.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 0ae81e159a8..51b05e559bd 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index aeb3027e820..9f143f05b38 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Keybindings related commands. usage: | @@ -33,7 +33,7 @@ For more information on input and keybindings, check: ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------- | | [`keybindings default`](/commands/docs/keybindings_default.md) | List default keybindings. | built-in | | [`keybindings list`](/commands/docs/keybindings_list.md) | List available options that can be used to create keybindings. | built-in | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index be22b585795..3bfd8b23819 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index f76a1d1ceed..04a440599be 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.97.1 +version: 0.98.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 3427befd9ef..6a1b028c06c 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index 20517a457d1..3b798e5b82e 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Kill a process using the process id. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 3e3ebb6a93b..f79e3ea2a14 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index e51f99ffed4..a4e6546a253 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.97.1 +version: 0.98.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 2f9511ac4ba..7d338b2eeb9 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.97.1 +version: 0.98.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 ee67488845b..059e13ac48a 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.97.1 +version: 0.98.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index 0ac89586f47..c84f9c5111a 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Converts input to lines. usage: | diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index b745664bb4a..0c44eb03b10 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Loads an environment update from a record. usage: | diff --git a/commands/docs/loop.md b/commands/docs/loop.md index c4c99697dff..bad2d23aefd 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.97.1 +version: 0.98.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 9cee3c1de0d..94747dc644f 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.97.1 +version: 0.98.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 21c907d0048..b5c29ec859a 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.97.1 +version: 0.98.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index bdcd56e28dd..26dd351f119 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.97.1 +version: 0.98.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | | [`math abs`](/commands/docs/math_abs.md) | Returns the absolute value of a number. | built-in | | [`math arccos`](/commands/docs/math_arccos.md) | Returns the arccosine of the number. | built-in | diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index 4887a0e2bc3..aae8804ee05 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.97.1 +version: 0.98.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 6c63d682bb5..f62b2c40c99 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index b8b4d0c4594..6208344b782 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the inverse of the hyperbolic cosine function. usage: | diff --git a/commands/docs/math_arcsin.md b/commands/docs/math_arcsin.md index b36960d95a1..b34358dd788 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index da18b30bb0c..2d7189f28f6 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the inverse of the hyperbolic sine function. usage: | diff --git a/commands/docs/math_arctan.md b/commands/docs/math_arctan.md index c75395d8811..cc9fafe1dfe 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index a9d7ee81093..6e0b3c77254 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the inverse of the hyperbolic tangent function. usage: | diff --git a/commands/docs/math_avg.md b/commands/docs/math_avg.md index f4d403e1c37..053e213d7cf 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.97.1 +version: 0.98.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 b9af5130afb..2c4d8ddc121 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.97.1 +version: 0.98.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 ab7e58a146a..3df18f3a8d1 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 50d8cfc52c4..c5385d36f55 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the hyperbolic cosine of the number. usage: | diff --git a/commands/docs/math_exp.md b/commands/docs/math_exp.md index d4b54ff154c..507e2a20175 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns e raised to the power of x. usage: | diff --git a/commands/docs/math_floor.md b/commands/docs/math_floor.md index f43baa081f7..41564beb12f 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.97.1 +version: 0.98.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 6d7fdd84cef..b1a8da29a55 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the natural logarithm. Base: (math e). usage: | diff --git a/commands/docs/math_log.md b/commands/docs/math_log.md index a4b3e6b8e62..e6d0ead4071 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the logarithm for an arbitrary base. usage: | diff --git a/commands/docs/math_max.md b/commands/docs/math_max.md index 33b622e70f1..dc5da45895a 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.97.1 +version: 0.98.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 b41ef06637a..979d908c6f0 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.97.1 +version: 0.98.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 f9c95d0cdaa..60d6b372800 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.97.1 +version: 0.98.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 cb2131ed74f..6976eb96ece 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.97.1 +version: 0.98.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 7bb2d848c9d..264e03e4e08 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.97.1 +version: 0.98.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 8e609006ec1..31f936dceb4 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.97.1 +version: 0.98.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 99e19bf176d..f3dd6ddfa27 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index 11a8df6a7f2..3ec078faa55 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the hyperbolic sine of the number. usage: | diff --git a/commands/docs/math_sqrt.md b/commands/docs/math_sqrt.md index 2372807dc61..699e5bff279 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the square root of the input number. usage: | diff --git a/commands/docs/math_stddev.md b/commands/docs/math_stddev.md index 72dfacdf039..2258cd5a1aa 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.97.1 +version: 0.98.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 3d657b67c7f..a8492185429 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.97.1 +version: 0.98.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 4e130ce0783..bd884cd0663 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 3f7bce5bfc9..f9c3a669178 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.97.1 +version: 0.98.0 math: | Returns the hyperbolic tangent of the number. usage: | diff --git a/commands/docs/math_variance.md b/commands/docs/math_variance.md index 142695df793..3be9aeee4e5 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.97.1 +version: 0.98.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 1e52ef0ab6a..3dadeb0e0b8 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.97.1 +version: 0.98.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 136b721ce2c..bfac02ef8c1 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Get the metadata for items in the stream. usage: | @@ -46,6 +46,7 @@ Get the metadata of the input ## Subcommands: -| name | usage | type | -| ------------------------------------------------ | ----------------------------------------- | -------- | -| [`metadata set`](/commands/docs/metadata_set.md) | Set the metadata for items in the stream. | built-in | +| name | description | type | +| ------------------------------------------------------ | ---------------------------------------------------------- | -------- | +| [`metadata access`](/commands/docs/metadata_access.md) | Access the metadata for the input stream within a closure. | built-in | +| [`metadata set`](/commands/docs/metadata_set.md) | Set the metadata for items in the stream. | built-in | \ No newline at end of file diff --git a/commands/docs/metadata_access.md b/commands/docs/metadata_access.md new file mode 100644 index 00000000000..7bf30d365ff --- /dev/null +++ b/commands/docs/metadata_access.md @@ -0,0 +1,43 @@ +--- +title: metadata access +categories: | + debug +version: 0.98.0 +debug: | + Access the metadata for the input stream within a closure. +usage: | + Access the metadata for the input stream within a closure. +--- + + +# `metadata access` for [debug](/commands/categories/debug.md) + +
Access the metadata for the input stream within a closure.
+ +## Signature + +```> metadata access {flags} (closure)``` + +## Parameters + + - `closure`: The closure to run with metadata access. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Access metadata and data from a stream together +```nu +> {foo: bar} | to json --raw | metadata access {|meta| {in: $in, meta: $meta}} +╭──────┬─────────────────────────────────────╮ +│ in │ {"foo":"bar"} │ +│ │ ╭──────────────┬──────────────────╮ │ +│ meta │ │ content_type │ application/json │ │ +│ │ ╰──────────────┴──────────────────╯ │ +╰──────┴─────────────────────────────────────╯ +``` diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index 2fc565480b6..8222388c580 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Set the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 7ea37165519..2fbeb81c005 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index a1f4f9d922a..ceb5d5b7aa6 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Create temporary files or directories using uutils/coreutils mktemp. usage: | diff --git a/commands/docs/module.md b/commands/docs/module.md index 3eca518f219..de347932f45 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.97.1 +version: 0.98.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 5c6c4f74697..c3969327aa6 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Move columns before or after other columns. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index 6b9aba049b1..27fe2acbb89 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.97.1 +version: 0.98.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 7cf9a5a0efa..e85b7d4d8e7 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | diff --git a/commands/docs/n.md b/commands/docs/n.md index aa5701686b5..3e9bd7128d5 100644 --- a/commands/docs/n.md +++ b/commands/docs/n.md @@ -2,7 +2,7 @@ title: n categories: | shells -version: 0.96.0 +version: 0.98.0 shells: | Switch to the next shell. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index 6393876438c..b7eb4a25531 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Validate and parse input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index a47499b87c9..2a9d8286bed 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 9cdc6e808db..302d790275e 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.97.1 +version: 0.98.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 3ed9c44f34a..a976f8839e6 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.97.1 +version: 0.98.0 core: | Commands for manipulating overlays. usage: | @@ -33,7 +33,7 @@ This command is a parser keyword. For details, check: ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------ | -------------------------------------------- | -------- | | [`overlay hide`](/commands/docs/overlay_hide.md) | Hide an active overlay. | keyword | | [`overlay list`](/commands/docs/overlay_list.md) | List all active overlays. | built-in | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 3511ac7e338..713f62e2b8c 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.97.1 +version: 0.98.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 96e9c1fee7a..68582a42983 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.97.1 +version: 0.98.0 core: | List all active overlays. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index 3f3a4ee287a..2a6db1d6f72 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.97.1 +version: 0.98.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 8877d3eed89..91da02273d8 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.97.1 +version: 0.98.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/p.md b/commands/docs/p.md index c0b029a02d4..2d987ceecdb 100644 --- a/commands/docs/p.md +++ b/commands/docs/p.md @@ -2,7 +2,7 @@ title: p categories: | shells -version: 0.96.0 +version: 0.98.0 shells: | Switch to the previous shell. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index f453f65ba3e..dd5b9cebb4e 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -1,18 +1,18 @@ --- title: panic categories: | - experimental -version: 0.97.1 -experimental: | - Executes a rust panic, useful only for testing. + debug +version: 0.98.0 +debug: | + Causes nushell to panic. usage: | - Executes a rust panic, useful only for testing. + Causes nushell to panic. --- -# `panic` for [experimental](/commands/categories/experimental.md) +# `panic` for [debug](/commands/categories/debug.md) -
Executes a rust panic, useful only for testing.
+
Causes nushell to panic.
## Signature @@ -20,11 +20,19 @@ usage: | ## Parameters - - `msg`: The glob pattern to use. + - `msg`: The custom message for the panic. ## Input/output types: -| input | output | -| ------- | ------ | -| nothing | table | +| input | output | +| ------- | ------- | +| nothing | nothing | + +## Examples + +Panic with a custom message +```nu +> panic 'This is a custom panic message' + +``` diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 9bcc0f0bbb3..e1865634474 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.97.1 +version: 0.98.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 fa083c8be38..85de1eace7f 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Parse columns from string data using a simple pattern or a supplied regular expression. usage: | diff --git a/commands/docs/path.md b/commands/docs/path.md index 84814f575c5..49a27ff7a26 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.97.1 +version: 0.98.0 path: | Explore and manipulate paths. usage: | @@ -43,7 +43,7 @@ the path literal. ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------------- | ----------------------------------------------------------------------- | -------- | | [`path basename`](/commands/docs/path_basename.md) | Get the final component of a path. | built-in | | [`path dirname`](/commands/docs/path_dirname.md) | Get the parent directory of a path. | built-in | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 7c2e67b7a4b..8783ad1e4d9 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.97.1 +version: 0.98.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 08278d9ed0e..88a6fd1fdef 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.97.1 +version: 0.98.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 8c16f924c9a..d718663783c 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.97.1 +version: 0.98.0 path: | Check whether a path exists. usage: | @@ -49,4 +49,5 @@ Check if files in list exist ## Notes This only checks if it is possible to either `open` or `cd` to the given path. -If you need to distinguish dirs and files, please use `path type`. \ No newline at end of file +If you need to distinguish dirs and files, please use `path type`. +Also note that if you don't have a permission to a directory of a path, false will be returned \ No newline at end of file diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 1bb0db80421..4ffe242a92c 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.97.1 +version: 0.98.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 235d63a58b8..15a45193e89 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.97.1 +version: 0.98.0 path: | Join a structured path or a list of path parts. usage: | diff --git a/commands/docs/path_parse.md b/commands/docs/path_parse.md index 5fa204c7dba..a00bbf740e1 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.97.1 +version: 0.98.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 c7d5346bd3a..f356e55120c 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.97.1 +version: 0.98.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 45b5906c010..210645d087b 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.97.1 +version: 0.98.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 08d46096ab3..bb225c43261 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.97.1 +version: 0.98.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index dc1f524c903..8cc09493173 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.97.1 +version: 0.98.0 plugin: | Commands for managing plugins. usage: | @@ -62,7 +62,7 @@ Remove the installed signatures for the `inc` plugin. ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------- | ------------------------------------------------------- | -------- | | [`plugin add`](/commands/docs/plugin_add.md) | Add a plugin to the plugin registry file. | built-in | | [`plugin list`](/commands/docs/plugin_list.md) | List installed plugins. | built-in | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index b2c697fb5de..75b9f592982 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.97.1 +version: 0.98.0 plugin: | Add a plugin to the plugin registry file. usage: | diff --git a/commands/docs/plugin_list.md b/commands/docs/plugin_list.md index 3947ff036d9..30b679fe7e5 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.97.1 +version: 0.98.0 plugin: | List installed plugins. usage: | @@ -33,7 +33,7 @@ List installed plugins. ╭───┬──────┬─────────┬────────────┬────────┬───────────────────────────────┬───────┬─────────────╮ │ # │ name │ version │ is_running │ pid │ filename │ shell │ commands │ ├───┼──────┼─────────┼────────────┼────────┼───────────────────────────────┼───────┼─────────────┤ -│ 0 │ inc │ 0.97.1 │ true │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ 0 │ inc │ 0.98.0 │ true │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ │ │ │ │ │ │ │ │ │ 0 │ inc │ │ │ │ │ │ │ │ │ │ ╰───┴─────╯ │ ╰───┴──────┴─────────┴────────────┴────────┴───────────────────────────────┴───────┴─────────────╯ diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 53f808f2a17..0a350ac1ba5 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.97.1 +version: 0.98.0 plugin: | Remove a plugin from the plugin registry file. usage: | diff --git a/commands/docs/plugin_stop.md b/commands/docs/plugin_stop.md index 026709dda16..3a4491e2b76 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.97.1 +version: 0.98.0 plugin: | Stop an installed plugin if it was running. usage: | diff --git a/commands/docs/plugin_use.md b/commands/docs/plugin_use.md index 9557c548e0e..6e30ca2dce9 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.97.1 +version: 0.98.0 plugin: | Load a plugin from the plugin registry file into scope. usage: | diff --git a/commands/docs/polars.md b/commands/docs/polars.md index fae1d454e09..120b940d765 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -36,7 +36,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | | [`polars agg`](/commands/docs/polars_agg.md) | Performs a series of aggregations from a group-by. | plugin | | [`polars agg-groups`](/commands/docs/polars_agg-groups.md) | Creates an agg_groups expression. | plugin | @@ -58,12 +58,12 @@ You must use one of the following subcommands. Using this command as-is will onl | [`polars collect`](/commands/docs/polars_collect.md) | Collect lazy dataframe into eager dataframe. | plugin | | [`polars columns`](/commands/docs/polars_columns.md) | Show dataframe columns. | plugin | | [`polars concat-str`](/commands/docs/polars_concat-str.md) | Creates a concat string expression. | plugin | -| [`polars concatenate`](/commands/docs/polars_concatenate.md) | Concatenates strings with other array. | plugin | | [`polars contains`](/commands/docs/polars_contains.md) | Checks if a pattern is contained in a string. | plugin | -| [`polars count`](/commands/docs/polars_count.md) | Creates a count expression. | plugin | +| [`polars count`](/commands/docs/polars_count.md) | Returns the number of non-null values in the column. | plugin | | [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | -| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a series. | plugin | +| [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a column or series. | plugin | | [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | +| [`polars decimal`](/commands/docs/polars_decimal.md) | Converts a string column into a decimal column | plugin | | [`polars drop`](/commands/docs/polars_drop.md) | Creates a new dataframe by dropping the selected columns. | plugin | | [`polars drop-duplicates`](/commands/docs/polars_drop-duplicates.md) | Drops duplicate values in dataframe. | plugin | | [`polars drop-nulls`](/commands/docs/polars_drop-nulls.md) | Drops null values in dataframe. | plugin | @@ -89,7 +89,8 @@ You must use one of the following subcommands. Using this command as-is will onl | [`polars get-weekday`](/commands/docs/polars_get-weekday.md) | Gets weekday from date. | plugin | | [`polars get-year`](/commands/docs/polars_get-year.md) | Gets year from date. | plugin | | [`polars group-by`](/commands/docs/polars_group-by.md) | Creates a group-by object that can be used for other aggregations. | plugin | -| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates a group to a Series. | plugin | +| [`polars implode`](/commands/docs/polars_implode.md) | Aggregates values into a list. | plugin | +| [`polars integer`](/commands/docs/polars_integer.md) | Converts a string column into a integer column | plugin | | [`polars into-df`](/commands/docs/polars_into-df.md) | Converts a list, table or record into a dataframe. | plugin | | [`polars into-lazy`](/commands/docs/polars_into-lazy.md) | Converts a dataframe into a lazy dataframe. | plugin | | [`polars into-nu`](/commands/docs/polars_into-nu.md) | Converts a dataframe or an expression into nushell value for access and exploration. | plugin | @@ -132,6 +133,7 @@ You must use one of the following subcommands. Using this command as-is will onl | [`polars store-get`](/commands/docs/polars_store-get.md) | Gets a Dataframe or other object from the plugin cache. | plugin | | [`polars store-ls`](/commands/docs/polars_store-ls.md) | Lists stored polars objects. | plugin | | [`polars store-rm`](/commands/docs/polars_store-rm.md) | Removes a stored Dataframe or other object from the plugin cache. | plugin | +| [`polars str-join`](/commands/docs/polars_str-join.md) | Concatenates strings within a column or dataframes | plugin | | [`polars str-lengths`](/commands/docs/polars_str-lengths.md) | Get lengths of all strings. | plugin | | [`polars str-slice`](/commands/docs/polars_str-slice.md) | Slices the string from the start position until the selected length. | plugin | | [`polars strftime`](/commands/docs/polars_strftime.md) | Formats date based on string rule. | plugin | diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index 5e463b70989..4bdf06357b5 100644 --- a/commands/docs/polars_agg-groups.md +++ b/commands/docs/polars_agg-groups.md @@ -1,16 +1,16 @@ --- title: polars agg-groups categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates an agg_groups expression. usage: | Creates an agg_groups expression. --- -# `polars agg-groups` for [expression](/commands/categories/expression.md) +# `polars agg-groups` for [dataframe](/commands/categories/dataframe.md)
Creates an agg_groups expression.
@@ -33,8 +33,27 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples - +Get the groiup index of the group by operations. ```nu -> +> [[group value]; [one 94] [one 95] [one 96] [two 97] [two 98] [two 99]] + | polars into-df + | polars group-by group + | polars agg (polars col value | polars agg-groups) + | polars collect + | polars sort-by group +╭───┬───────┬───────────╮ +│ # │ group │ values │ +├───┼───────┼───────────┤ +│ 0 │ one │ ╭───┬───╮ │ +│ │ │ │ 0 │ 0 │ │ +│ │ │ │ 1 │ 1 │ │ +│ │ │ │ 2 │ 2 │ │ +│ │ │ ╰───┴───╯ │ +│ 1 │ two │ ╭───┬───╮ │ +│ │ │ │ 0 │ 3 │ │ +│ │ │ │ 1 │ 4 │ │ +│ │ │ │ 2 │ 5 │ │ +│ │ │ ╰───┴───╯ │ +╰───┴───────┴───────────╯ ``` diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index 7f633f8a174..86760f14ae5 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | @@ -40,33 +40,15 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Group by and perform an aggregation ```nu > [[a b]; [1 2] [1 4] [2 6] [2 4]] - | polars into-df - | polars group-by a - | polars agg [ - (polars col b | polars min | polars as "b_min") - (polars col b | polars max | polars as "b_max") - (polars col b | polars sum | polars as "b_sum") - ] -╭───┬───┬───────┬───────┬───────╮ -│ # │ a │ b_min │ b_max │ b_sum │ -├───┼───┼───────┼───────┼───────┤ -│ 0 │ 1 │ 2 │ 4 │ 6 │ -│ 1 │ 2 │ 4 │ 6 │ 10 │ -╰───┴───┴───────┴───────┴───────╯ - -``` - -Group by and perform an aggregation -```nu -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | polars into-lazy - | polars group-by a - | polars agg [ - (polars col b | polars min | polars as "b_min") - (polars col b | polars max | polars as "b_max") - (polars col b | polars sum | polars as "b_sum") - ] - | polars collect + | polars into-lazy + | polars group-by a + | polars agg [ + (polars col b | polars min | polars as "b_min") + (polars col b | polars max | polars as "b_max") + (polars col b | polars sum | polars as "b_sum") + ] + | polars collect + | polars sort-by a ╭───┬───┬───────┬───────┬───────╮ │ # │ a │ b_min │ b_max │ b_sum │ ├───┼───┼───────┼───────┼───────┤ diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index 4bf68f200d7..0e37924e2a8 100644 --- a/commands/docs/polars_all-false.md +++ b/commands/docs/polars_all-false.md @@ -2,7 +2,7 @@ title: polars all-false categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Returns true if all values are false. usage: | diff --git a/commands/docs/polars_all-true.md b/commands/docs/polars_all-true.md index df311271676..ef12bc34467 100644 --- a/commands/docs/polars_all-true.md +++ b/commands/docs/polars_all-true.md @@ -2,7 +2,7 @@ title: polars all-true categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Returns true if all values are true. usage: | diff --git a/commands/docs/polars_append.md b/commands/docs/polars_append.md index 2ce13a2292b..de1df1d15a4 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 35fac8264a4..684dbb0d346 100644 --- a/commands/docs/polars_arg-max.md +++ b/commands/docs/polars_arg-max.md @@ -2,7 +2,7 @@ title: polars arg-max categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Return index for max value in series. usage: | diff --git a/commands/docs/polars_arg-min.md b/commands/docs/polars_arg-min.md index 30052d8cce0..b8a3fb93f1f 100644 --- a/commands/docs/polars_arg-min.md +++ b/commands/docs/polars_arg-min.md @@ -2,7 +2,7 @@ title: polars arg-min categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Return index for min value in series. usage: | diff --git a/commands/docs/polars_arg-sort.md b/commands/docs/polars_arg-sort.md index 702e01e7c91..c5d136f8458 100644 --- a/commands/docs/polars_arg-sort.md +++ b/commands/docs/polars_arg-sort.md @@ -2,7 +2,7 @@ title: polars arg-sort categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Returns indexes for a sorted series. usage: | diff --git a/commands/docs/polars_arg-true.md b/commands/docs/polars_arg-true.md index 70e3aea0d52..54864574b1d 100644 --- a/commands/docs/polars_arg-true.md +++ b/commands/docs/polars_arg-true.md @@ -2,7 +2,7 @@ title: polars arg-true categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Returns indexes where values are true. usage: | diff --git a/commands/docs/polars_arg-unique.md b/commands/docs/polars_arg-unique.md index 6d41bc1446c..6e0d08ecca0 100644 --- a/commands/docs/polars_arg-unique.md +++ b/commands/docs/polars_arg-unique.md @@ -2,7 +2,7 @@ title: polars arg-unique categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Returns indexes for unique values. usage: | diff --git a/commands/docs/polars_arg-where.md b/commands/docs/polars_arg-where.md index d3c14816de2..dbb4c7d25f9 100644 --- a/commands/docs/polars_arg-where.md +++ b/commands/docs/polars_arg-where.md @@ -2,7 +2,7 @@ title: polars arg-where categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates an expression that returns the arguments where expression is true. usage: | diff --git a/commands/docs/polars_as-date.md b/commands/docs/polars_as-date.md index 97b2e1637ea..59e81f16a76 100644 --- a/commands/docs/polars_as-date.md +++ b/commands/docs/polars_as-date.md @@ -2,7 +2,7 @@ title: polars as-date categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index ec2fa1e6121..0474d8fe8c4 100644 --- a/commands/docs/polars_as-datetime.md +++ b/commands/docs/polars_as-datetime.md @@ -2,7 +2,7 @@ title: polars as-datetime categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 1c090999654..1166bab8d22 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index 1b8f07c06d8..3f2d3614477 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -1,16 +1,16 @@ --- title: polars cache categories: | - lazyframe -version: 0.97.1 -lazyframe: | + dataframe +version: 0.98.0 +dataframe: | Caches operations in a new LazyFrame. usage: | Caches operations in a new LazyFrame. --- -# `polars cache` for [lazyframe](/commands/categories/lazyframe.md) +# `polars cache` for [dataframe](/commands/categories/dataframe.md)
Caches operations in a new LazyFrame.
@@ -35,6 +35,16 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Caches the result into a new LazyFrame ```nu -> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars reverse | polars cache +> [[a b]; [6 2] [4 2] [2 2]] | polars into-df + | polars reverse + | polars cache + | polars sort-by a +╭───┬───┬───╮ +│ # │ a │ b │ +├───┼───┼───┤ +│ 0 │ 2 │ 2 │ +│ 1 │ 4 │ 2 │ +│ 2 │ 6 │ 2 │ +╰───┴───┴───╯ ``` diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index fb051bea7de..26cf54a8721 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Cast a column to a different dtype. usage: | diff --git a/commands/docs/polars_col.md b/commands/docs/polars_col.md index 6222654695a..38557b8289b 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates a named column expression. usage: | @@ -26,7 +26,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Parameters - - `column name`: Name of column to be used + - `column name`: Name of column to be used. '*' can be used for all columns. ## Input/output types: @@ -45,3 +45,16 @@ Creates a named column expression and converts it to a nu object │ value │ a │ ╰───────┴────────╯ ``` + +Select all columns using the asterisk wildcard. +```nu +> [[a b]; [x 1] [y 2] [z 3]] | polars into-df | polars select (polars col '*') | polars collect +╭───┬───┬───╮ +│ # │ a │ b │ +├───┼───┼───┤ +│ 0 │ x │ 1 │ +│ 1 │ y │ 2 │ +│ 2 │ z │ 3 │ +╰───┴───┴───╯ + +``` diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index 556317561ea..7ebccea3526 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index 3febd0c87fc..e21c9b16d24 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 45ba858d9f9..e5a680beb8a 100644 --- a/commands/docs/polars_concat-str.md +++ b/commands/docs/polars_concat-str.md @@ -2,7 +2,7 @@ title: polars concat-str categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/polars_concatenate.md b/commands/docs/polars_concatenate.md deleted file mode 100644 index 7bb8ecf478f..00000000000 --- a/commands/docs/polars_concatenate.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: polars concatenate -categories: | - dataframe -version: 0.97.1 -dataframe: | - Concatenates strings with other array. -usage: | - Concatenates strings with other array. ---- - - -# `polars concatenate` for [dataframe](/commands/categories/dataframe.md) - -
Concatenates strings with other array.
- -::: warning This command requires a plugin -The `polars concatenate` command resides in the `polars` plugin. -To use this command, you must install and register `nu_plugin_polars`. -See the [Plugins](/book/plugins.html) chapter in the book for more information. -::: - -## Signature - -```> polars concatenate {flags} (other)``` - -## Parameters - - - `other`: Other array with string to be concatenated - - -## Input/output types: - -| input | output | -| ----- | ------ | -| any | any | - -## Examples - -Concatenate string -```nu -> let other = ([za xs cd] | polars into-df); - [abc abc abc] | polars into-df | polars concatenate $other -╭───┬───────╮ -│ # │ 0 │ -├───┼───────┤ -│ 0 │ abcza │ -│ 1 │ abcxs │ -│ 2 │ abccd │ -╰───┴───────╯ - -``` diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 3d3c16f2840..db617a93821 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Checks if a pattern is contained in a string. usage: | @@ -37,6 +37,21 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Returns boolean indicating if pattern was found in a column +```nu +> let df = [[a]; [abc] [acb] [acb]] | polars into-df; + let df2 = $df | polars with-column [(polars col a | polars contains ab | polars as b)] | polars collect; + $df2.b +╭───┬───────╮ +│ # │ b │ +├───┼───────┤ +│ 0 │ true │ +│ 1 │ false │ +│ 2 │ false │ +╰───┴───────╯ + +``` + Returns boolean indicating if pattern was found ```nu > [abc acb acb] | polars into-df | polars contains ab diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index 241e35e0a05..ac445803657 100644 --- a/commands/docs/polars_count-null.md +++ b/commands/docs/polars_count-null.md @@ -2,7 +2,7 @@ title: polars count-null categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 6873458c987..905ef5d18a7 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -1,18 +1,18 @@ --- title: polars count categories: | - expression -version: 0.97.1 -expression: | - Creates a count expression. + dataframe +version: 0.98.0 +dataframe: | + Returns the number of non-null values in the column. usage: | - Creates a count expression. + Returns the number of non-null values in the column. --- -# `polars count` for [expression](/commands/categories/expression.md) +# `polars count` for [dataframe](/commands/categories/dataframe.md) -
Creates a count expression.
+
Returns the number of non-null values in the column.
::: warning This command requires a plugin The `polars count` command resides in the `polars` plugin. @@ -33,8 +33,15 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples - +Count the number of non-null values in a column ```nu -> +> [[a]; ["foo"] ["bar"] [null]] | polars into-df + | polars select (polars col a | polars count) + | polars collect +╭───┬───╮ +│ # │ a │ +├───┼───┤ +│ 0 │ 2 │ +╰───┴───╯ ``` diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index 687f7124ed8..88d0154456d 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,17 +2,17 @@ title: polars cumulative categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | - Cumulative calculation for a series. + Cumulative calculation for a column or series. usage: | - Cumulative calculation for a series. + Cumulative calculation for a column or series. --- # `polars cumulative` for [dataframe](/commands/categories/dataframe.md) -
Cumulative calculation for a series.
+
Cumulative calculation for a column or series.
::: warning This command requires a plugin The `polars cumulative` command resides in the `polars` plugin. @@ -30,7 +30,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Parameters - - `type`: rolling operation + - `type`: rolling operation. Values of min, max, and sum are accepted. ## Input/output types: @@ -41,6 +41,24 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Cumulative sum for a column +```nu +> [[a]; [1] [2] [3] [4] [5]] + | polars into-df + | polars select (polars col a | polars cumulative sum | polars as cum_a) + | polars collect +╭───┬───────╮ +│ # │ cum_a │ +├───┼───────┤ +│ 0 │ 1 │ +│ 1 │ 3 │ +│ 2 │ 6 │ +│ 3 │ 10 │ +│ 4 │ 15 │ +╰───┴───────╯ + +``` + Cumulative sum for a series ```nu > [1 2 3 4 5] | polars into-df | polars cumulative sum diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index f75e24dad00..fab6401554f 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md new file mode 100644 index 00000000000..8b66dc128c5 --- /dev/null +++ b/commands/docs/polars_decimal.md @@ -0,0 +1,49 @@ +--- +title: polars decimal +categories: | + dataframe +version: 0.98.0 +dataframe: | + Converts a string column into a decimal column +usage: | + Converts a string column into a decimal column +--- + + +# `polars decimal` for [dataframe](/commands/categories/dataframe.md) + +
Converts a string column into a decimal column
+ +::: warning This command requires a plugin +The `polars decimal` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + +## Signature + +```> polars decimal {flags} (infer_length)``` + +## Parameters + + - `infer_length`: Number of decimal points to infer + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Modifies strings to decimal +```nu +> [[a b]; [1, '2.4']] | polars into-df | polars select (polars col b | polars decimal 2) | polars collect +╭───┬──────╮ +│ # │ b │ +├───┼──────┤ +│ 0 │ 2.40 │ +╰───┴──────╯ + +``` diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index 44e23c3c548..151efc78a4e 100644 --- a/commands/docs/polars_drop-duplicates.md +++ b/commands/docs/polars_drop-duplicates.md @@ -2,7 +2,7 @@ title: polars drop-duplicates categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Drops duplicate values in dataframe. usage: | @@ -44,12 +44,14 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. drop duplicates ```nu -> [[a b]; [1 2] [3 4] [1 2]] | polars into-df | polars drop-duplicates +> [[a b]; [1 2] [3 4] [1 2]] | polars into-df + | polars drop-duplicates + | polars sort-by a ╭───┬───┬───╮ │ # │ a │ b │ ├───┼───┼───┤ -│ 0 │ 3 │ 4 │ -│ 1 │ 1 │ 2 │ +│ 0 │ 1 │ 2 │ +│ 1 │ 3 │ 4 │ ╰───┴───┴───╯ ``` diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index fa9264c9da5..1169d6f22af 100644 --- a/commands/docs/polars_drop-nulls.md +++ b/commands/docs/polars_drop-nulls.md @@ -2,7 +2,7 @@ title: polars drop-nulls categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index 24efa6f705b..36677600c5a 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates a new dataframe by dropping the selected columns. usage: | diff --git a/commands/docs/polars_dummies.md b/commands/docs/polars_dummies.md index 33d89d2aa12..d634bbdf0fe 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 6cbed01ecd7..b1d193ac804 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | @@ -39,7 +39,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Explode the specified dataframe ```nu -> [[id name hobbies]; [1 Mercy [Cycling Knitting]] [2 Bob [Skiing Football]]] | polars into-df | polars explode hobbies | polars collect +> [[id name hobbies]; [1 Mercy [Cycling Knitting]] [2 Bob [Skiing Football]]] + | polars into-df + | polars explode hobbies + | polars collect + | polars sort-by [id, name] ╭───┬────┬───────┬──────────╮ │ # │ id │ name │ hobbies │ ├───┼────┼───────┼──────────┤ diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index f33ffb8fefa..58e033d4562 100644 --- a/commands/docs/polars_expr-not.md +++ b/commands/docs/polars_expr-not.md @@ -1,16 +1,16 @@ --- title: polars expr-not categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates a not expression. usage: | Creates a not expression. --- -# `polars expr-not` for [expression](/commands/categories/expression.md) +# `polars expr-not` for [dataframe](/commands/categories/dataframe.md)
Creates a not expression.
@@ -38,3 +38,23 @@ Creates a not expression > (polars col a) > 2) | polars expr-not ``` + +Adds a column showing which values of col a are not greater than 2 +```nu +> [[a]; [1] [2] [3] [4] [5]] | polars into-df + | polars with-column [(((polars col a) > 2) + | polars expr-not + | polars as a_expr_not)] + | polars collect + | polars sort-by a +╭───┬───┬───────╮ +│ # │ a │ b │ +├───┼───┼───────┤ +│ 0 │ 1 │ true │ +│ 1 │ 2 │ true │ +│ 2 │ 3 │ false │ +│ 3 │ 4 │ false │ +│ 4 │ 5 │ false │ +╰───┴───┴───────╯ + +``` diff --git a/commands/docs/polars_fetch.md b/commands/docs/polars_fetch.md index 3f94db09a0a..28b0af5bd40 100644 --- a/commands/docs/polars_fetch.md +++ b/commands/docs/polars_fetch.md @@ -2,7 +2,7 @@ title: polars fetch categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Collects the lazyframe to the selected rows. usage: | diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index c15451c9aa7..97174263c26 100644 --- a/commands/docs/polars_fill-nan.md +++ b/commands/docs/polars_fill-nan.md @@ -2,7 +2,7 @@ title: polars fill-nan categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Replaces NaN values with the given expression. usage: | diff --git a/commands/docs/polars_fill-null.md b/commands/docs/polars_fill-null.md index c02734dfce8..d417470c534 100644 --- a/commands/docs/polars_fill-null.md +++ b/commands/docs/polars_fill-null.md @@ -2,7 +2,7 @@ title: polars fill-null categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Replaces NULL values with the given expression. usage: | diff --git a/commands/docs/polars_filter-with.md b/commands/docs/polars_filter-with.md index b5ae516032b..7b0cafcaf20 100644 --- a/commands/docs/polars_filter-with.md +++ b/commands/docs/polars_filter-with.md @@ -2,7 +2,7 @@ title: polars filter-with categories: | dataframe or lazyframe -version: 0.97.1 +version: 0.98.0 dataframe_or_lazyframe: | Filters dataframe using a mask or expression as reference. usage: | diff --git a/commands/docs/polars_filter.md b/commands/docs/polars_filter.md index 3ae1c4f206f..9b269e0a78f 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index 44712aad4f6..6437be71441 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Show only the first number of rows or create a first expression usage: | diff --git a/commands/docs/polars_flatten.md b/commands/docs/polars_flatten.md index 97461dd4d63..5f8a12290e5 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | An alias for polars explode. usage: | diff --git a/commands/docs/polars_get-day.md b/commands/docs/polars_get-day.md index ddfa57244fd..01379520672 100644 --- a/commands/docs/polars_get-day.md +++ b/commands/docs/polars_get-day.md @@ -2,7 +2,7 @@ title: polars get-day categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index e22a90675c8..9285e8ccb9a 100644 --- a/commands/docs/polars_get-hour.md +++ b/commands/docs/polars_get-hour.md @@ -2,7 +2,7 @@ title: polars get-hour categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets hour from date. usage: | diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index 2915b7cd949..6566f52c685 100644 --- a/commands/docs/polars_get-minute.md +++ b/commands/docs/polars_get-minute.md @@ -2,7 +2,7 @@ title: polars get-minute categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index 3f724f9174c..8b3db26a804 100644 --- a/commands/docs/polars_get-month.md +++ b/commands/docs/polars_get-month.md @@ -2,7 +2,7 @@ title: polars get-month categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 13446d18aaf..a803f4396a6 100644 --- a/commands/docs/polars_get-nanosecond.md +++ b/commands/docs/polars_get-nanosecond.md @@ -2,7 +2,7 @@ title: polars get-nanosecond categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index 6c58520b946..62c968bf794 100644 --- a/commands/docs/polars_get-ordinal.md +++ b/commands/docs/polars_get-ordinal.md @@ -2,7 +2,7 @@ title: polars get-ordinal categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index f3c49f1672c..5881a340453 100644 --- a/commands/docs/polars_get-second.md +++ b/commands/docs/polars_get-second.md @@ -2,7 +2,7 @@ title: polars get-second categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index b4953836717..3e4ef1f07b3 100644 --- a/commands/docs/polars_get-week.md +++ b/commands/docs/polars_get-week.md @@ -2,7 +2,7 @@ title: polars get-week categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index b34df98825b..6305ed0a57b 100644 --- a/commands/docs/polars_get-weekday.md +++ b/commands/docs/polars_get-weekday.md @@ -2,7 +2,7 @@ title: polars get-weekday categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index d2e22c64064..ce4acff047f 100644 --- a/commands/docs/polars_get-year.md +++ b/commands/docs/polars_get-year.md @@ -2,7 +2,7 @@ title: polars get-year categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index 515407808e4..2b1e21e921c 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates dataframe with the selected columns. usage: | diff --git a/commands/docs/polars_group-by.md b/commands/docs/polars_group-by.md index ea4f6fabece..995ab5c7da3 100644 --- a/commands/docs/polars_group-by.md +++ b/commands/docs/polars_group-by.md @@ -2,7 +2,7 @@ title: polars group-by categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | @@ -37,25 +37,6 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples -Group by and perform an aggregation -```nu -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | polars into-df - | polars group-by a - | polars agg [ - (polars col b | polars min | polars as "b_min") - (polars col b | polars max | polars as "b_max") - (polars col b | polars sum | polars as "b_sum") - ] -╭───┬───┬───────┬───────┬───────╮ -│ # │ a │ b_min │ b_max │ b_sum │ -├───┼───┼───────┼───────┼───────┤ -│ 0 │ 1 │ 2 │ 4 │ 6 │ -│ 1 │ 2 │ 4 │ 6 │ 10 │ -╰───┴───┴───────┴───────┴───────╯ - -``` - Group by and perform an aggregation ```nu > [[a b]; [1 2] [1 4] [2 6] [2 4]] @@ -67,6 +48,7 @@ Group by and perform an aggregation (polars col b | polars sum | polars as "b_sum") ] | polars collect + | polars sort-by a ╭───┬───┬───────┬───────┬───────╮ │ # │ a │ b_min │ b_max │ b_sum │ ├───┼───┼───────┼───────┼───────┤ diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index c26b26baec8..e0a36ea592e 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -1,18 +1,18 @@ --- title: polars implode categories: | - expression -version: 0.97.1 -expression: | - Aggregates a group to a Series. + dataframe +version: 0.98.0 +dataframe: | + Aggregates values into a list. usage: | - Aggregates a group to a Series. + Aggregates values into a list. --- -# `polars implode` for [expression](/commands/categories/expression.md) +# `polars implode` for [dataframe](/commands/categories/dataframe.md) -
Aggregates a group to a Series.
+
Aggregates values into a list.
::: warning This command requires a plugin The `polars implode` command resides in the `polars` plugin. @@ -33,8 +33,17 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples - +Create two lists for columns a and b with all the rows as values. ```nu -> +> [[a b]; [1 4] [2 5] [3 6]] | polars into-df | polars select (polars col '*' | polars implode) | polars collect +╭───┬───────────┬───────────╮ +│ # │ a │ b │ +├───┼───────────┼───────────┤ +│ 0 │ ╭───┬───╮ │ ╭───┬───╮ │ +│ │ │ 0 │ 1 │ │ │ 0 │ 4 │ │ +│ │ │ 1 │ 2 │ │ │ 1 │ 5 │ │ +│ │ │ 2 │ 3 │ │ │ 2 │ 6 │ │ +│ │ ╰───┴───╯ │ ╰───┴───╯ │ +╰───┴───────────┴───────────╯ ``` diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md new file mode 100644 index 00000000000..85dfa634ca5 --- /dev/null +++ b/commands/docs/polars_integer.md @@ -0,0 +1,45 @@ +--- +title: polars integer +categories: | + dataframe +version: 0.98.0 +dataframe: | + Converts a string column into a integer column +usage: | + Converts a string column into a integer column +--- + + +# `polars integer` for [dataframe](/commands/categories/dataframe.md) + +
Converts a string column into a integer column
+ +::: warning This command requires a plugin +The `polars integer` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + +## Signature + +```> polars integer {flags} ``` + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Modifies strings to integer +```nu +> [[a b]; [1, '2']] | polars into-df | polars select (polars col b | polars integer) | polars collect +╭───┬───╮ +│ # │ b │ +├───┼───┤ +│ 0 │ 2 │ +╰───┴───╯ + +``` diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index 90f354c88c4..4388ed6e008 100644 --- a/commands/docs/polars_into-df.md +++ b/commands/docs/polars_into-df.md @@ -2,7 +2,7 @@ title: polars into-df categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 699737ecb58..6f6b7efc516 100644 --- a/commands/docs/polars_into-lazy.md +++ b/commands/docs/polars_into-lazy.md @@ -2,7 +2,7 @@ title: polars into-lazy categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Converts a dataframe into a lazy dataframe. usage: | diff --git a/commands/docs/polars_into-nu.md b/commands/docs/polars_into-nu.md index 1fe0508a2aa..30f751a62d0 100644 --- a/commands/docs/polars_into-nu.md +++ b/commands/docs/polars_into-nu.md @@ -2,7 +2,7 @@ title: polars into-nu categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Converts a dataframe or an expression into nushell value for access and exploration. usage: | diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index f854bec4289..33fbb33973c 100644 --- a/commands/docs/polars_is-duplicated.md +++ b/commands/docs/polars_is-duplicated.md @@ -2,7 +2,7 @@ title: polars is-duplicated categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates mask indicating duplicated values. usage: | diff --git a/commands/docs/polars_is-in.md b/commands/docs/polars_is-in.md index 238b894fd6a..b8f93713084 100644 --- a/commands/docs/polars_is-in.md +++ b/commands/docs/polars_is-in.md @@ -2,7 +2,7 @@ title: polars is-in categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates an is-in expression or checks to see if the elements are contained in the right series usage: | diff --git a/commands/docs/polars_is-not-null.md b/commands/docs/polars_is-not-null.md index 0d563402749..7aadcf2c4af 100644 --- a/commands/docs/polars_is-not-null.md +++ b/commands/docs/polars_is-not-null.md @@ -2,7 +2,7 @@ title: polars is-not-null categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates mask where value is not null. usage: | diff --git a/commands/docs/polars_is-null.md b/commands/docs/polars_is-null.md index af642e0566c..daefb530305 100644 --- a/commands/docs/polars_is-null.md +++ b/commands/docs/polars_is-null.md @@ -2,7 +2,7 @@ title: polars is-null categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates mask where value is null. usage: | diff --git a/commands/docs/polars_is-unique.md b/commands/docs/polars_is-unique.md index d17c525c33a..60ab1839c0f 100644 --- a/commands/docs/polars_is-unique.md +++ b/commands/docs/polars_is-unique.md @@ -2,7 +2,7 @@ title: polars is-unique categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index fc5ddafcf40..cd0d8f28670 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Joins a lazy frame with other lazy frame. usage: | diff --git a/commands/docs/polars_last.md b/commands/docs/polars_last.md index 4564c10b25c..52beb6558e2 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 01acbe60d34..058cac46607 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index f519482effe..519677ee8a4 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Lowercase the strings in the column. usage: | @@ -33,6 +33,17 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Modifies strings in a column to lowercase +```nu +> [[a]; [Abc]] | polars into-df | polars select (polars col a | polars lowercase) | polars collect +╭───┬─────╮ +│ # │ a │ +├───┼─────┤ +│ 0 │ abc │ +╰───┴─────╯ + +``` + Modifies strings to lowercase ```nu > [Abc aBc abC] | polars into-df | polars lowercase diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index d1fd42089a5..2090bdf9a04 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -1,16 +1,16 @@ --- title: polars max categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates a max expression or aggregates columns to their max value. usage: | Creates a max expression or aggregates columns to their max value. --- -# `polars max` for [expression](/commands/categories/expression.md) +# `polars max` for [dataframe](/commands/categories/dataframe.md)
Creates a max expression or aggregates columns to their max value.
@@ -47,9 +47,11 @@ Max value from columns in a dataframe Max aggregation for a group-by ```nu > [[a b]; [one 2] [one 4] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars max) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars max) + | polars collect + | polars sort-by a ╭───┬─────┬───╮ │ # │ a │ b │ ├───┼─────┼───┤ diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index 4de278d7c3a..f177ea0310b 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -1,16 +1,16 @@ --- title: polars mean categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | Creates a mean expression for an aggregation or aggregates columns to their mean value. --- -# `polars mean` for [expression](/commands/categories/expression.md) +# `polars mean` for [dataframe](/commands/categories/dataframe.md)
Creates a mean expression for an aggregation or aggregates columns to their mean value.
@@ -47,9 +47,11 @@ Mean value from columns in a dataframe Mean aggregation for a group-by ```nu > [[a b]; [one 2] [one 4] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars mean) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars mean) + | polars collect + | polars sort-by a ╭───┬─────┬──────╮ │ # │ a │ b │ ├───┼─────┼──────┤ diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index 311420b311a..99f41c862da 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | @@ -36,9 +36,11 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Median aggregation for a group-by ```nu > [[a b]; [one 2] [one 4] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars median) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars median) + | polars collect + | polars sort-by a ╭───┬─────┬──────╮ │ # │ a │ b │ ├───┼─────┼──────┤ @@ -50,7 +52,7 @@ Median aggregation for a group-by Median value from columns in a dataframe ```nu -> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars median +> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars median | polars collect ╭───┬──────┬──────╮ │ # │ a │ b │ ├───┼──────┼──────┤ diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index 1a61733b22b..583eac98baa 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -1,16 +1,16 @@ --- title: polars min categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates a min expression or aggregates columns to their min value. usage: | Creates a min expression or aggregates columns to their min value. --- -# `polars min` for [expression](/commands/categories/expression.md) +# `polars min` for [dataframe](/commands/categories/dataframe.md)
Creates a min expression or aggregates columns to their min value.
@@ -47,9 +47,11 @@ Min value from columns in a dataframe Min aggregation for a group-by ```nu > [[a b]; [one 2] [one 4] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars min) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars min) + | polars collect + | polars sort-by a ╭───┬─────┬───╮ │ # │ a │ b │ ├───┼─────┼───┤ diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index 242a18b88c3..59d3a91971e 100644 --- a/commands/docs/polars_n-unique.md +++ b/commands/docs/polars_n-unique.md @@ -2,7 +2,7 @@ title: polars n-unique categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 547f14edfe9..2a95cf79f5d 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 01b9790932e..b193b5ec96c 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Opens CSV, JSON, NDJSON/JSON lines, arrow, avro, or parquet file to create dataframe. A lazy dataframe will be created by default, if supported. usage: | diff --git a/commands/docs/polars_otherwise.md b/commands/docs/polars_otherwise.md index 49c6694377f..28c7f694a3b 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Completes a when expression. usage: | diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index 3859951230d..39e9d9317d0 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Pivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index 0e6d067867a..08a409dc1e9 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | @@ -51,9 +51,11 @@ quantile value from columns in a dataframe Quantile aggregation for a group-by ```nu > [[a b]; [one 2] [one 4] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars quantile 0.5) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars quantile 0.5) + | polars collect + | polars sort-by a ╭───┬─────┬──────╮ │ # │ a │ b │ ├───┼─────┼──────┤ diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index 53f76150e89..72730af3a48 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.97.1 +version: 0.98.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/polars_rename.md b/commands/docs/polars_rename.md index b224865af6d..1d295753fbf 100644 --- a/commands/docs/polars_rename.md +++ b/commands/docs/polars_rename.md @@ -2,7 +2,7 @@ title: polars rename categories: | dataframe or lazyframe -version: 0.97.1 +version: 0.98.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/polars_replace-all.md b/commands/docs/polars_replace-all.md index 2fa70ebe234..3204930c044 100644 --- a/commands/docs/polars_replace-all.md +++ b/commands/docs/polars_replace-all.md @@ -2,7 +2,7 @@ title: polars replace-all categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | @@ -38,6 +38,19 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Replaces string in a column +```nu +> [[a]; [abac] [abac] [abac]] | polars into-df | polars select (polars col a | polars replace-all --pattern a --replace A) | polars collect +╭───┬──────╮ +│ # │ a │ +├───┼──────┤ +│ 0 │ AbAc │ +│ 1 │ AbAc │ +│ 2 │ AbAc │ +╰───┴──────╯ + +``` + Replaces string ```nu > [abac abac abac] | polars into-df | polars replace-all --pattern a --replace A diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 3044e0a9e05..e8958e1da36 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | @@ -38,6 +38,18 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Replaces string in column +```nu +> [[a]; [abc] [abcabc]] | polars into-df | polars select (polars col a | polars replace --pattern ab --replace AB) | polars collect +╭───┬────────╮ +│ # │ a │ +├───┼────────┤ +│ 0 │ ABc │ +│ 1 │ ABcabc │ +╰───┴────────╯ + +``` + Replaces string ```nu > [abc abc abc] | polars into-df | polars replace --pattern ab --replace AB diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index daada104b14..32e715ab68b 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -1,16 +1,16 @@ --- title: polars reverse categories: | - lazyframe -version: 0.97.1 -lazyframe: | + dataframe +version: 0.98.0 +dataframe: | Reverses the LazyFrame usage: | Reverses the LazyFrame --- -# `polars reverse` for [lazyframe](/commands/categories/lazyframe.md) +# `polars reverse` for [dataframe](/commands/categories/dataframe.md)
Reverses the LazyFrame
diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index a5cfa41ddd6..b679f988cfa 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Rolling calculation for a series. usage: | diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index af3b0607094..33ccb7881cb 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index 79bc38570c4..6b8af41c5c8 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Saves a dataframe to disk. For lazy dataframes a sink operation will be used if the file type supports it (parquet, ipc/arrow, csv, and ndjson). usage: | diff --git a/commands/docs/polars_schema.md b/commands/docs/polars_schema.md index 4b36a544074..ea44e044e43 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 829938798c4..1d88b02f4a6 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index adbda1c5591..6bf49bbb684 100644 --- a/commands/docs/polars_set-with-idx.md +++ b/commands/docs/polars_set-with-idx.md @@ -2,7 +2,7 @@ title: polars set-with-idx categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index 130804b25e2..9adfb4ad041 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Sets value where given mask is true. usage: | diff --git a/commands/docs/polars_shape.md b/commands/docs/polars_shape.md index db893a42254..1271da36d2c 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Shows column and row size for a dataframe. usage: | diff --git a/commands/docs/polars_shift.md b/commands/docs/polars_shift.md index 422d9214c5d..a239c73077b 100644 --- a/commands/docs/polars_shift.md +++ b/commands/docs/polars_shift.md @@ -2,7 +2,7 @@ title: polars shift categories: | dataframe or lazyframe -version: 0.97.1 +version: 0.98.0 dataframe_or_lazyframe: | Shifts the values by a given period. usage: | diff --git a/commands/docs/polars_slice.md b/commands/docs/polars_slice.md index d5ad035928e..3756d961dfb 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates new dataframe from a slice of rows. usage: | diff --git a/commands/docs/polars_sort-by.md b/commands/docs/polars_sort-by.md index 564b0986961..a1cd062a6b7 100644 --- a/commands/docs/polars_sort-by.md +++ b/commands/docs/polars_sort-by.md @@ -2,7 +2,7 @@ title: polars sort-by categories: | lazyframe -version: 0.97.1 +version: 0.98.0 lazyframe: | Sorts a lazy dataframe based on expression(s). usage: | diff --git a/commands/docs/polars_std.md b/commands/docs/polars_std.md index aa4d5423efe..18b56fdd9b1 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -1,16 +1,16 @@ --- title: polars std categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | Creates a std expression for an aggregation of std value from columns in a dataframe. --- -# `polars std` for [expression](/commands/categories/expression.md) +# `polars std` for [dataframe](/commands/categories/dataframe.md)
Creates a std expression for an aggregation of std value from columns in a dataframe.
@@ -35,7 +35,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Std value from columns in a dataframe ```nu -> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars std +> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars std | polars collect ╭───┬──────┬──────╮ │ # │ a │ b │ ├───┼──────┼──────┤ @@ -47,9 +47,11 @@ Std value from columns in a dataframe Std aggregation for a group-by ```nu > [[a b]; [one 2] [one 2] [two 1] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars std) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars std) + | polars collect + | polars sort-by a ╭───┬─────┬──────╮ │ # │ a │ b │ ├───┼─────┼──────┤ diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index 1c4a84f1e1f..5804e7e7db0 100644 --- a/commands/docs/polars_store-get.md +++ b/commands/docs/polars_store-get.md @@ -2,7 +2,7 @@ title: polars store-get categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Gets a Dataframe or other object from the plugin cache. usage: | diff --git a/commands/docs/polars_store-ls.md b/commands/docs/polars_store-ls.md index 5868e9e42c2..1d7db032586 100644 --- a/commands/docs/polars_store-ls.md +++ b/commands/docs/polars_store-ls.md @@ -2,7 +2,7 @@ title: polars store-ls categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Lists stored polars objects. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index 53d71b06130..a48217b400f 100644 --- a/commands/docs/polars_store-rm.md +++ b/commands/docs/polars_store-rm.md @@ -2,7 +2,7 @@ title: polars store-rm categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Removes a stored Dataframe or other object from the plugin cache. usage: | diff --git a/commands/docs/polars_str-join.md b/commands/docs/polars_str-join.md new file mode 100644 index 00000000000..34940605961 --- /dev/null +++ b/commands/docs/polars_str-join.md @@ -0,0 +1,68 @@ +--- +title: polars str-join +categories: | + dataframe +version: 0.98.0 +dataframe: | + Concatenates strings within a column or dataframes +usage: | + Concatenates strings within a column or dataframes +--- + + +# `polars str-join` for [dataframe](/commands/categories/dataframe.md) + +
Concatenates strings within a column or dataframes
+ +::: warning This command requires a plugin +The `polars str-join` command resides in the `polars` plugin. +To use this command, you must install and register `nu_plugin_polars`. +See the [Plugins](/book/plugins.html) chapter in the book for more information. +::: + +## Signature + +```> polars str-join {flags} (other)``` + +## Flags + + - `--delimiter, -d {string}`: Delimiter to join strings within an expression. Other dataframe when used with a dataframe. + - `--ignore-nulls, -n`: Ignore null values. Only available when used as an expression. + +## Parameters + + - `other`: Other dataframe with a single series of strings to be concatenated. Required when used with a dataframe, ignored when used as an expression. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| any | any | + +## Examples + +Join strings in a column +```nu +> [[a]; [abc] [abc] [abc]] | polars into-df | polars select (polars col a | polars str-join -d ',') | polars collect +╭───┬─────────────╮ +│ # │ a │ +├───┼─────────────┤ +│ 0 │ abc,abc,abc │ +╰───┴─────────────╯ + +``` + +StrJoin strings across two series +```nu +> let other = ([za xs cd] | polars into-df); + [abc abc abc] | polars into-df | polars str-join $other +╭───┬───────╮ +│ # │ 0 │ +├───┼───────┤ +│ 0 │ abcza │ +│ 1 │ abcxs │ +│ 2 │ abccd │ +╰───┴───────╯ + +``` diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index 83c626afb0c..fdcb7852d85 100644 --- a/commands/docs/polars_str-lengths.md +++ b/commands/docs/polars_str-lengths.md @@ -2,7 +2,7 @@ title: polars str-lengths categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Get lengths of all strings. usage: | @@ -24,6 +24,10 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ```> polars str-lengths {flags} ``` +## Flags + + - `--bytes, -b`: Get the length in bytes instead of chars. + ## Input/output types: @@ -33,6 +37,19 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Returns string lengths for a column +```nu +> [[a]; [a] [ab] [abc]] | polars into-df | polars select (polars col a | polars str-lengths) | polars collect +╭───┬───╮ +│ # │ a │ +├───┼───┤ +│ 0 │ 1 │ +│ 1 │ 2 │ +│ 2 │ 3 │ +╰───┴───╯ + +``` + Returns string lengths ```nu > [a ab abc] | polars into-df | polars str-lengths diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index c0370e3b269..44352a4effc 100644 --- a/commands/docs/polars_str-slice.md +++ b/commands/docs/polars_str-slice.md @@ -2,7 +2,7 @@ title: polars str-slice categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Slices the string from the start position until the selected length. usage: | @@ -41,6 +41,19 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Creates slices from the strings in a specified column +```nu +> [[a]; [abcded] [abc321] [abc123]] | polars into-df | polars select (polars col a | polars str-slice 1 --length 2) | polars collect +╭───┬────╮ +│ # │ a │ +├───┼────┤ +│ 0 │ bc │ +│ 1 │ bc │ +│ 2 │ bc │ +╰───┴────╯ + +``` + Creates slices from the strings ```nu > [abcded abc321 abc123] | polars into-df | polars str-slice 1 --length 2 diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index e48c82ee351..1d9c4b1535a 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Formats date based on string rule. usage: | @@ -37,6 +37,20 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Formats date column as a string +```nu +> let date = '2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'; + let df = ([[a]; [$date]] | polars into-df); + let df2 = $df | polars with-column [(polars col a | polars strftime "%Y/%m/%d" | polars as b)] | polars collect; + $df2.b +╭───┬────────────╮ +│ # │ b │ +├───┼────────────┤ +│ 0 │ 2020/08/04 │ +╰───┴────────────╯ + +``` + Formats date ```nu > let dt = ('2020-08-04T16:39:18+00:00' | into datetime --timezone 'UTC'); diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index f3e816353bd..bee5af787e2 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -1,16 +1,16 @@ --- title: polars sum categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | Creates a sum expression for an aggregation or aggregates columns to their sum value. --- -# `polars sum` for [expression](/commands/categories/expression.md) +# `polars sum` for [dataframe](/commands/categories/dataframe.md)
Creates a sum expression for an aggregation or aggregates columns to their sum value.
@@ -35,7 +35,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Sums all columns in a dataframe ```nu -> [[a b]; [6 2] [1 4] [4 1]] | polars into-df | polars sum +> [[a b]; [6 2] [1 4] [4 1]] | polars into-df | polars sum | polars collect ╭───┬────┬───╮ │ # │ a │ b │ ├───┼────┼───┤ @@ -47,9 +47,11 @@ Sums all columns in a dataframe Sum aggregation for a group-by ```nu > [[a b]; [one 2] [one 4] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars sum) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars sum) + | polars collect + | polars sort-by a ╭───┬─────┬───╮ │ # │ a │ b │ ├───┼─────┼───┤ diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 5d659435a46..a1ae339f77e 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | For a dataframe, produces descriptive statistics (summary statistics) for its numeric columns. usage: | diff --git a/commands/docs/polars_take.md b/commands/docs/polars_take.md index 84817dae590..9df480e9701 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index dc43325c52f..8d3fc862b31 100644 --- a/commands/docs/polars_unique.md +++ b/commands/docs/polars_unique.md @@ -2,7 +2,7 @@ title: polars unique categories: | dataframe or lazyframe -version: 0.97.1 +version: 0.98.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index 039f87fdb9c..9d491e2a310 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Unpivot a DataFrame from wide to long format. usage: | diff --git a/commands/docs/polars_uppercase.md b/commands/docs/polars_uppercase.md index cd3829f3c98..aa0191d7991 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Uppercase the strings in the column. usage: | @@ -33,6 +33,17 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Examples +Modifies strings in a column to uppercase +```nu +> [[a]; [Abc]] | polars into-df | polars select (polars col a | polars uppercase) | polars collect +╭───┬─────╮ +│ # │ a │ +├───┼─────┤ +│ 0 │ ABC │ +╰───┴─────╯ + +``` + Modifies strings to uppercase ```nu > [Abc aBc abC] | polars into-df | polars uppercase diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index 39159bb998e..4ad3cd229e2 100644 --- a/commands/docs/polars_value-counts.md +++ b/commands/docs/polars_value-counts.md @@ -2,7 +2,7 @@ title: polars value-counts categories: | dataframe -version: 0.97.1 +version: 0.98.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | @@ -42,12 +42,12 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Calculates value counts ```nu -> [5 5 5 5 6 6] | polars into-df | polars value-counts +> [5 5 5 5 6 6] | polars into-df | polars value-counts | polars sort-by count ╭───┬───┬───────╮ │ # │ 0 │ count │ ├───┼───┼───────┤ -│ 0 │ 5 │ 4 │ -│ 1 │ 6 │ 2 │ +│ 0 │ 6 │ 2 │ +│ 1 │ 5 │ 4 │ ╰───┴───┴───────╯ ``` diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index e4d6a12c26e..9c4a545bf4a 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -1,16 +1,16 @@ --- title: polars var categories: | - expression -version: 0.97.1 -expression: | + dataframe +version: 0.98.0 +dataframe: | Create a var expression for an aggregation. usage: | Create a var expression for an aggregation. --- -# `polars var` for [expression](/commands/categories/expression.md) +# `polars var` for [dataframe](/commands/categories/dataframe.md)
Create a var expression for an aggregation.
@@ -35,7 +35,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. Var value from columns in a dataframe or aggregates columns to their var value ```nu -> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars var +> [[a b]; [6 2] [4 2] [2 2]] | polars into-df | polars var | polars collect ╭───┬──────┬──────╮ │ # │ a │ b │ ├───┼──────┼──────┤ @@ -47,9 +47,11 @@ Var value from columns in a dataframe or aggregates columns to their var value Var aggregation for a group-by ```nu > [[a b]; [one 2] [one 2] [two 1] [two 1]] - | polars into-df - | polars group-by a - | polars agg (polars col b | polars var) + | polars into-df + | polars group-by a + | polars agg (polars col b | polars var) + | polars collect + | polars sort-by a ╭───┬─────┬──────╮ │ # │ a │ b │ ├───┼─────┼──────┤ diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index 6ae30982c37..5f6b16a8fb1 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.97.1 +version: 0.98.0 expression: | Creates and modifies a when expression. usage: | diff --git a/commands/docs/polars_with-column.md b/commands/docs/polars_with-column.md index 1700473072b..d2afdf8686f 100644 --- a/commands/docs/polars_with-column.md +++ b/commands/docs/polars_with-column.md @@ -2,7 +2,7 @@ title: polars with-column categories: | dataframe or lazyframe -version: 0.97.1 +version: 0.98.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index bd775546da5..f52b40b2012 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.97.1 +version: 0.98.0 network: | Get a free port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 176c1925b32..db8a65f5c52 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index cda7383d615..dbcff5f172e 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 39d25d1b29f..a28826cbb10 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index dd2764bd85f..e55f3af0cb2 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.97.1 +version: 0.98.0 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 7b7094d3780..ceea5b64b5c 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Show all the query commands usage: | @@ -34,7 +34,7 @@ See the [Plugins](/book/plugins.html) chapter in the book for more information. ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- | -------- | | [`query db`](/commands/docs/query_db.md) | Query a database using SQL. | built-in | | [`query json`](/commands/docs/query_json.md) | execute json query on json file (open --raw \ | query json 'query string') | plugin | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 7562c4356ae..a81f59faa1b 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.97.1 +version: 0.98.0 database: | Query a database using SQL. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 023ceb7eb27..4ff99f83977 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | execute json query on json file (open --raw | query json 'query string') usage: | diff --git a/commands/docs/query_web.md b/commands/docs/query_web.md index e072c82f023..947cf0d1390 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.97.1 +version: 0.98.0 network: | execute selector query on html/web usage: | diff --git a/commands/docs/query_webpage-info.md b/commands/docs/query_webpage-info.md index 20cb2259871..9391b1fe31a 100644 --- a/commands/docs/query_webpage-info.md +++ b/commands/docs/query_webpage-info.md @@ -2,7 +2,7 @@ title: query webpage-info categories: | network -version: 0.97.1 +version: 0.98.0 network: | uses the webpage crate to extract info from html: title, description, language, links, RSS feeds, Opengraph, Schema.org, and more usage: | diff --git a/commands/docs/query_xml.md b/commands/docs/query_xml.md index e6d72786c3a..9f2504f5e2f 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | execute xpath query on xml usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index b17ac85a3ed..9b07ed63cd8 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate a random value. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------------- | --------------------------------------------------------------------------------------------- | -------- | | [`random binary`](/commands/docs/random_binary.md) | Generate random bytes. | built-in | | [`random bool`](/commands/docs/random_bool.md) | Generate a random boolean value. | built-in | diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index 291e19b39b2..a6aef8272dc 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index 2408f1dc761..d5e3bcc5f35 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index e13d2d6e7d1..4bc0cdb19a9 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate random chars uniformly distributed over ASCII letters and numbers: a-z, A-Z and 0-9. usage: | diff --git a/commands/docs/random_dice.md b/commands/docs/random_dice.md index ca57ee6058e..16af02a712f 100644 --- a/commands/docs/random_dice.md +++ b/commands/docs/random_dice.md @@ -2,7 +2,7 @@ title: random dice categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate a random dice roll. usage: | diff --git a/commands/docs/random_float.md b/commands/docs/random_float.md index ed18aaafdb9..a6d2ef835df 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate a random float within a range [min..max]. usage: | diff --git a/commands/docs/random_int.md b/commands/docs/random_int.md index 43c490e7cc6..fd400bfc8f2 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 529e4692bd9..7dc728b76c7 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.97.1 +version: 0.98.0 random: | Generate a random uuid4 string. usage: | diff --git a/commands/docs/range.md b/commands/docs/range.md index 98f8600f780..ec13f27c05d 100644 --- a/commands/docs/range.md +++ b/commands/docs/range.md @@ -2,7 +2,7 @@ title: range categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index de9fcae662a..a2ea6457c0b 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index f8d74f8a4fb..3edbbee2239 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.96.0 +version: 0.98.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index e45c09641bf..e5f09992396 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.97.1 +version: 0.98.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 dc797e72024..e2ee2fc795a 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 9b73443c384..c09e4fa0a44 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.97.1 +version: 0.98.0 core: | Return early from a function. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 062e3323e65..19618b4d9ef 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index f4f0fa86e21..8af86567da8 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index b9a35558576..086c0e6c4bd 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Rolling commands for tables. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------- | ---------------------------------- | -------- | | [`roll down`](/commands/docs/roll_down.md) | Roll table rows down. | built-in | | [`roll left`](/commands/docs/roll_left.md) | Roll record or table columns left. | built-in | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index 1ab3f9e623f..76f7910c1a7 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 42ffc7fb1d5..a6ff6a214ec 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 533793f7ddd..0691c357483 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index e5a4324fa6c..e88f43d8118 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index 5c7f687ec5d..97b799dec5c 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.97.1 +version: 0.98.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 e6a8f83f899..5ac1c38e4f5 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.97.1 +version: 0.98.0 system: | Runs external command. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index 2e2a5ca73d5..ba502dd4412 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Save a file. usage: | diff --git a/commands/docs/schema.md b/commands/docs/schema.md index 086026cc3e9..388528c385b 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.97.1 +version: 0.98.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index a53950812e2..b0dd58af681 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.97.1 +version: 0.98.0 core: | Commands for getting info about what is in scope. usage: | @@ -28,7 +28,7 @@ usage: | ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------------ | -------------------------------------------------------- | -------- | | [`scope aliases`](/commands/docs/scope_aliases.md) | Output info on the aliases in the current scope. | built-in | | [`scope commands`](/commands/docs/scope_commands.md) | Output info on the commands in the current scope. | built-in | diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index c319631a33b..89967665897 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.97.1 +version: 0.98.0 core: | Output info on the aliases in the current scope. usage: | diff --git a/commands/docs/scope_commands.md b/commands/docs/scope_commands.md index 5629590a051..8faf572d8ba 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.97.1 +version: 0.98.0 core: | Output info on the commands in the current scope. usage: | diff --git a/commands/docs/scope_engine-stats.md b/commands/docs/scope_engine-stats.md index 80ee699e032..d39aea6a0db 100644 --- a/commands/docs/scope_engine-stats.md +++ b/commands/docs/scope_engine-stats.md @@ -2,7 +2,7 @@ title: scope engine-stats categories: | core -version: 0.97.1 +version: 0.98.0 core: | Output stats on the engine in the current state. usage: | diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index a3458f99806..2cb7679b6e6 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.97.1 +version: 0.98.0 core: | Output info on the known externals in the current scope. usage: | diff --git a/commands/docs/scope_modules.md b/commands/docs/scope_modules.md index 910b4643dce..1226d63fbb1 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.97.1 +version: 0.98.0 core: | Output info on the modules in the current scope. usage: | diff --git a/commands/docs/scope_variables.md b/commands/docs/scope_variables.md index 71bcdd86a24..79972ea1b35 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.97.1 +version: 0.98.0 core: | Output info on the variables in the current scope. usage: | diff --git a/commands/docs/select.md b/commands/docs/select.md index 3d8ec2fc6d4..38ebc4f4c6e 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.97.1 +version: 0.98.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 d3e7c712cf7..5a47c66a59e 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.97.1 +version: 0.98.0 generators: | Output sequences of numbers. usage: | @@ -77,7 +77,7 @@ sequence 1 to 5, then convert to a string with a pipe separator ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------- | ------------------------------------- | -------- | | [`seq char`](/commands/docs/seq_char.md) | Print a sequence of ASCII characters. | built-in | | [`seq date`](/commands/docs/seq_date.md) | Print sequences of dates. | built-in | \ No newline at end of file diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index c3061d405f3..6093001845f 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.97.1 +version: 0.98.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index c4465140045..60cb6ab85ef 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.97.1 +version: 0.98.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shells.md b/commands/docs/shells.md index 3d94d0a4829..362768cc893 100644 --- a/commands/docs/shells.md +++ b/commands/docs/shells.md @@ -2,7 +2,7 @@ title: shells categories: | shells -version: 0.96.0 +version: 0.98.0 shells: | Lists all open shells. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 64399aea0df..9e6e1524f1e 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index 0380461d3f1..ffe46a2f34b 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. usage: | @@ -67,7 +67,7 @@ To skip specific numbered rows, try `drop nth`. To skip specific named columns, ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------- | ----------------------------------------------------- | -------- | | [`skip until`](/commands/docs/skip_until.md) | Skip elements of the input until a predicate is true. | built-in | | [`skip while`](/commands/docs/skip_while.md) | Skip elements of the input while a predicate is true. | built-in | \ No newline at end of file diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 50543a4c60d..6eebbf8d786 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.97.1 +version: 0.98.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 61962d489e5..5875e20a4ed 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.97.1 +version: 0.98.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 cf60a8ec72f..5bcc05ca53f 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.97.1 +version: 0.98.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 f4af1cdfd8c..06d2a3578b2 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Sort by the given columns, in increasing order. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index 356288f2241..8f1bc30cdf4 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Sort in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 291f2a0532e..aa834428f77 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.97.1 +version: 0.98.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 4f0f5385954..7d07d1d3f2e 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.97.1 +version: 0.98.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 fc2bf01b449..b70b04fb96b 100644 --- a/commands/docs/split-by.md +++ b/commands/docs/split-by.md @@ -2,7 +2,7 @@ title: split-by categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Split a record into groups. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index 36ba1572af1..740949fe647 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | @@ -30,10 +30,11 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | -| ------------------------------------------------ | ------------------------------------------------------- | -------- | -| [`split chars`](/commands/docs/split_chars.md) | Split a string into a list of characters. | built-in | -| [`split column`](/commands/docs/split_column.md) | Split a string into multiple columns using a separator. | built-in | -| [`split list`](/commands/docs/split_list.md) | Split a list into multiple lists using a separator. | built-in | -| [`split row`](/commands/docs/split_row.md) | Split a string into multiple rows using a separator. | built-in | -| [`split words`](/commands/docs/split_words.md) | Split a string's words into separate rows. | built-in | \ No newline at end of file +| name | description | type | +| ------------------------------------------------------ | ------------------------------------------------------- | -------- | +| [`split cell-path`](/commands/docs/split_cell-path.md) | Split a cell-path into its components. | built-in | +| [`split chars`](/commands/docs/split_chars.md) | Split a string into a list of characters. | built-in | +| [`split column`](/commands/docs/split_column.md) | Split a string into multiple columns using a separator. | built-in | +| [`split list`](/commands/docs/split_list.md) | Split a list into multiple lists using a separator. | built-in | +| [`split row`](/commands/docs/split_row.md) | Split a string into multiple rows using a separator. | built-in | +| [`split words`](/commands/docs/split_words.md) | Split a string's words into separate rows. | built-in | \ No newline at end of file diff --git a/commands/docs/split_cell-path.md b/commands/docs/split_cell-path.md new file mode 100644 index 00000000000..e8ae4966b2e --- /dev/null +++ b/commands/docs/split_cell-path.md @@ -0,0 +1,55 @@ +--- +title: split cell-path +categories: | + conversions +version: 0.98.0 +conversions: | + Split a cell-path into its components. +usage: | + Split a cell-path into its components. +--- + + +# `split cell-path` for [conversions](/commands/categories/conversions.md) + +
Split a cell-path into its components.
+ +## Signature + +```> split cell-path {flags} ``` + + +## Input/output types: + +| input | output | +| --------- | --------- | +| cell-path | list\ | + +## Examples + +Split a cell-path into its components +```nu +> $.5?.c | split cell-path +╭───┬───────┬──────────╮ +│ # │ value │ optional │ +├───┼───────┼──────────┤ +│ 0 │ 5 │ true │ +│ 1 │ c │ false │ +╰───┴───────┴──────────╯ + +``` + +Split a complex cell-path +```nu +> $.a.b?.1."2"."c.d" | split cell-path +╭───┬───────┬──────────╮ +│ # │ value │ optional │ +├───┼───────┼──────────┤ +│ 0 │ a │ false │ +│ 1 │ b │ true │ +│ 2 │ 1 │ false │ +│ 3 │ 2 │ false │ +│ 4 │ c.d │ false │ +╰───┴───────┴──────────╯ + +``` diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index 890559ae4a2..383bd21745d 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.97.1 +version: 0.98.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 eefa5b16f35..8e2faea5497 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Split a string into multiple columns using a separator. usage: | @@ -21,6 +21,7 @@ usage: | ## Flags - `--collapse-empty, -c`: remove empty columns + - `--number, -n {int}`: Split into maximum number of items - `--regex, -r`: separator is a regular expression ## Parameters @@ -82,3 +83,15 @@ Split a list of strings into a table, ignoring padding ╰───┴─────────┴─────────╯ ``` + +Split into columns, last column may contain the delimiter +```nu +> ['author: Salina Yoon' r#'title: Where's Ellie?: A Hide-and-Seek Book'#] | split column --number 2 ': ' key value +╭───┬────────┬──────────────────────────────────────╮ +│ # │ key │ value │ +├───┼────────┼──────────────────────────────────────┤ +│ 0 │ author │ Salina Yoon │ +│ 1 │ title │ Where's Ellie?: A Hide-and-Seek Book │ +╰───┴────────┴──────────────────────────────────────╯ + +``` diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index db3dce396e8..68b09f1e24e 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Split a list into multiple lists using a separator. usage: | diff --git a/commands/docs/split_row.md b/commands/docs/split_row.md index ebf5e27ced6..8ee8297f6aa 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.97.1 +version: 0.98.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 b5d9cb1875a..b770ebeb957 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index c5ebf0af965..27b1e2ee8b9 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Open a folder, file or website in the default application or viewer. usage: | diff --git a/commands/docs/stor.md b/commands/docs/stor.md index d09f32d02fe..6c0427e2c9a 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.97.1 +version: 0.98.0 database: | Various commands for working with the in-memory sqlite database. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------- | --------------------------------------------------------------------------- | -------- | | [`stor create`](/commands/docs/stor_create.md) | Create a table in the in-memory sqlite database. | built-in | | [`stor delete`](/commands/docs/stor_delete.md) | Delete a table or specified rows in the in-memory sqlite database. | built-in | diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index aad6d0fd56e..5bd7e1cfec2 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.97.1 +version: 0.98.0 database: | Create a table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_delete.md b/commands/docs/stor_delete.md index 069fe150a4e..dea5b14c296 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.97.1 +version: 0.98.0 database: | Delete a table or specified rows in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_export.md b/commands/docs/stor_export.md index 695e288a003..a57346ff456 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.97.1 +version: 0.98.0 database: | Export the in-memory sqlite database to a sqlite database file. usage: | diff --git a/commands/docs/stor_import.md b/commands/docs/stor_import.md index 06e8fd8a76e..f775a4563c6 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.97.1 +version: 0.98.0 database: | Import a sqlite database file into the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_insert.md b/commands/docs/stor_insert.md index 3cad169e034..55e3a4e1da6 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.97.1 +version: 0.98.0 database: | Insert information into a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_open.md b/commands/docs/stor_open.md index dd9e5259373..2e1523ec9c1 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.97.1 +version: 0.98.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index d1a98e2a843..bb0df5ceeab 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.97.1 +version: 0.98.0 database: | Reset the in-memory database by dropping all tables. usage: | diff --git a/commands/docs/stor_update.md b/commands/docs/stor_update.md index fd21d743f74..a8b92d8fc9c 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.97.1 +version: 0.98.0 database: | Update information in a specified table in the in-memory sqlite database. usage: | diff --git a/commands/docs/str.md b/commands/docs/str.md index 6fd7fde5e83..81ba8d0958c 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Various commands for working with string data. usage: | @@ -30,12 +30,11 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | -------- | | [`str camel-case`](/commands/docs/str_camel-case.md) | Convert a string to camelCase. | built-in | | [`str capitalize`](/commands/docs/str_capitalize.md) | Capitalize first letter of text. | built-in | | [`str contains`](/commands/docs/str_contains.md) | Checks if string input contains a substring. | built-in | -| [`str deunicode`](/commands/docs/str_deunicode.md) | Convert Unicode string to pure ASCII. | built-in | | [`str distance`](/commands/docs/str_distance.md) | Compare two strings and return the edit distance/Levenshtein distance. | built-in | | [`str downcase`](/commands/docs/str_downcase.md) | Make text lowercase. | built-in | | [`str ends-with`](/commands/docs/str_ends-with.md) | Check if an input ends with a string. | built-in | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index 134c9de2f9b..948c35dbe7d 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.97.1 +version: 0.98.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 3dd21915dfd..382114d8f8e 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Capitalize first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index eb7f46b32c4..98e1aa00a0f 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_deunicode.md b/commands/docs/str_deunicode.md deleted file mode 100644 index e7d70088928..00000000000 --- a/commands/docs/str_deunicode.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: str deunicode -categories: | - strings -version: 0.97.1 -strings: | - Convert Unicode string to pure ASCII. -usage: | - Convert Unicode string to pure ASCII. ---- - - -# `str deunicode` for [strings](/commands/categories/strings.md) - -
Convert Unicode string to pure ASCII.
- -## Signature - -```> str deunicode {flags} ``` - - -## Input/output types: - -| input | output | -| ------ | ------ | -| string | string | - -## Examples - -deunicode a string -```nu -> 'A…B' | str deunicode -A...B -``` diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index afcb68ab8ed..fd9fa6182de 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.97.1 +version: 0.98.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 5a969e2da83..f78a62bb98f 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Make text lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index ab71a18f652..a3b6360aacb 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.97.1 +version: 0.98.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 e734c77687c..5946aa9c536 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.97.1 +version: 0.98.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 7088b9317a1..4964699917f 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.97.1 +version: 0.98.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 74e855d5301..8931334b83b 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.97.1 +version: 0.98.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 949f95833ca..4853a752bf3 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.97.1 +version: 0.98.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index bd3ce17d9e7..fd31bf80194 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.97.1 +version: 0.98.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 2e72c98765b..921491f65f3 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.97.1 +version: 0.98.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 8a828b8310b..3a54a68f5bf 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Find and replace text. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index 05150cabafa..9c310b9fdf8 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.97.1 +version: 0.98.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 363adcd0ecf..8541d4f00f3 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.97.1 +version: 0.98.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 ddc8fbee2e1..bf6d5a90b0b 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.97.1 +version: 0.98.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 d527aa631a9..df2eb657cb5 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.97.1 +version: 0.98.0 strings: | Check if an input starts with a string. usage: | diff --git a/commands/docs/str_stats.md b/commands/docs/str_stats.md index bd63c1a81c7..3956108532d 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Gather word count statistics on the text. usage: | diff --git a/commands/docs/str_substring.md b/commands/docs/str_substring.md index 615f2184d72..9a3116f57a8 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Get part of a string. Note that the first character of a string is index 0. usage: | diff --git a/commands/docs/str_title-case.md b/commands/docs/str_title-case.md index 965939039fb..ac1855f6a65 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.97.1 +version: 0.98.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index 33aadaf9a5b..94ef2c5f951 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index ac60d3d8ab4..3e2bf13150b 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Make text uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index e63b3c1e1bd..2538d087b61 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the system. usage: | @@ -38,7 +38,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------ | ----------------------------------------------------- | -------- | | [`sys cpu`](/commands/docs/sys_cpu.md) | View information about the system CPUs. | built-in | | [`sys disks`](/commands/docs/sys_disks.md) | View information about the system disks. | built-in | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index 6a5da3664ad..becd1cf7c0b 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index e68ed49a20a..e918ee1d3fe 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index ca3e6a3c78d..794be2972e7 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index 0fc3c2c2f35..7a3dc62493d 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index e262da94ec4..9de74493d1c 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the system network interfaces. usage: | diff --git a/commands/docs/sys_temp.md b/commands/docs/sys_temp.md index 78dda0aa0d5..8147416fced 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.97.1 +version: 0.98.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index 74d304d40aa..37eb510cc3b 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.97.1 +version: 0.98.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index 1ecb33b8404..ecfc94e3732 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.97.1 +version: 0.98.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index 544cbdc4a09..3e695b8287f 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. usage: | @@ -86,7 +86,7 @@ Return the first 3 elements of a range ## Subcommands: -| name | usage | type | +| name | description | type | | -------------------------------------------- | ----------------------------------------------------- | -------- | | [`take until`](/commands/docs/take_until.md) | Take elements of the input until a predicate is true. | built-in | | [`take while`](/commands/docs/take_while.md) | Take elements of the input while a predicate is true. | built-in | \ No newline at end of file diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index c61fab5e144..e6fe72da107 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.97.1 +version: 0.98.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 377c7fce275..a566d676e59 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Take elements of the input while a predicate is true. usage: | diff --git a/commands/docs/tee.md b/commands/docs/tee.md index 895a44f691e..1b7e7399e91 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Copy a stream to another command in parallel. usage: | @@ -53,6 +53,12 @@ Print numbers and their sum ``` +Do something with a value on another thread, while also passing through the value +```nu +> 10000 | tee { 1..$in | print } | $in * 5 +50000 +``` + ## Notes This is useful for doing something else with a stream while still continuing to use it in your pipeline. \ No newline at end of file diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index e92ef7a8db0..27ed4b62115 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.97.1 +version: 0.98.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 568f19811bf..d598d9ee64d 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Time the running time of a block. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index c834ecf6d97..df8a336caa4 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Translate structured data to a format. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------- | ------------------------------------------------------------- | -------- | | [`to csv`](/commands/docs/to_csv.md) | Convert table into .csv text . | built-in | | [`to html`](/commands/docs/to_html.md) | Convert table into simple HTML. | built-in | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 7f7c04a5d5a..140f8a46635 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 8461938fd52..63bfa966d3f 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index 2bcac0b7a13..fc5b20ef952 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index fad02fb434f..3f157be5766 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index d20dba78d57..f180dbf24c2 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index 7cf3b8a671a..51946126fb3 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert Nu values into brotli-compressed MessagePack. usage: | diff --git a/commands/docs/to_nuon.md b/commands/docs/to_nuon.md index 5e5ec11b1ea..86094623e2e 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Converts table data into Nuon (Nushell Object Notation) text. usage: | diff --git a/commands/docs/to_plist.md b/commands/docs/to_plist.md index 21b4c804379..bf325bd9c60 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert Nu values into plist usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index 1a00cad2a0d..cc94420208d 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Converts data into simple text. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index fcf0222d28b..b4e086624a2 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 443fa76d137..2cca8d19b09 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index 02b5676ecfb..297fbcb136a 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert special record structure into .xml text. usage: | diff --git a/commands/docs/to_yaml.md b/commands/docs/to_yaml.md index 68ab44c791a..69d675044e1 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.97.1 +version: 0.98.0 formats: | Convert table into .yaml/.yml text. usage: | diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 5748869f81b..c2617c966dd 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.97.1 +version: 0.98.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index 73398d9404e..df0ea3f43d1 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Transposes the table contents so rows become columns and columns become rows. usage: | diff --git a/commands/docs/try.md b/commands/docs/try.md index 37380d8755d..1aaec2bf7b7 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.97.1 +version: 0.98.0 core: | Try to run a block, if it fails optionally run a catch closure. usage: | @@ -32,21 +32,21 @@ usage: | ## Examples -Try to run a missing command +Try to run a division by zero ```nu -> try { asdfasdf } +> try { 1 / 0 } ``` -Try to run a missing command +Try to run a division by zero and return a string instead ```nu -> try { asdfasdf } catch { 'missing' } -missing +> try { 1 / 0 } catch { 'divided by zero' } +divided by zero ``` -Try to run a missing command and report the message +Try to run a division by zero and report the message ```nu -> try { asdfasdf } catch { |err| $err.msg } +> try { 1 / 0 } catch { |err| $err.msg } ``` diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 6a73f9e1d74..288065f2422 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.97.1 +version: 0.98.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index a229643cf49..8571bd0d380 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 792421977c0..317bb1207c5 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.97.1 +version: 0.98.0 system: | Print certain system information using uutils/coreutils uname. usage: | diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index 1f5ba983393..6c79b902eac 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.97.1 +version: 0.98.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 6c6b19b34c6..0dbc95721d0 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 7db6355a97d..23b60cf7e84 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Update an existing column to have a new value. usage: | @@ -93,6 +93,6 @@ When updating a specific index, the closure will instead be run once. The first ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------ | ----------------------- | -------- | | [`update cells`](/commands/docs/update_cells.md) | Update the table cells. | built-in | diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index b60db126013..d29c74a55ff 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Update the table cells. usage: | diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index 90ca983925c..216dc0ae995 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.97.1 +version: 0.98.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 3e06285a480..8b58c4ff29b 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.97.1 +version: 0.98.0 network: | Various commands for working with URLs. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ------------------------------------------------------ | --------------------------------------------------------------------- | -------- | | [`url build-query`](/commands/docs/url_build-query.md) | Converts record or table into query string applying percent-encoding. | built-in | | [`url decode`](/commands/docs/url_decode.md) | Converts a percent-encoded web safe string to a string. | built-in | diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index 3bf7fe3b118..51de3031438 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.97.1 +version: 0.98.0 network: | Converts record or table into query string applying percent-encoding. usage: | diff --git a/commands/docs/url_decode.md b/commands/docs/url_decode.md index 43048fb2392..71c0af4b906 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.97.1 +version: 0.98.0 strings: | Converts a percent-encoded web safe string to a string. usage: | diff --git a/commands/docs/url_encode.md b/commands/docs/url_encode.md index 96c4d213b26..a81ad15aa01 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.97.1 +version: 0.98.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 27dff05b700..c0871fac9fb 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.97.1 +version: 0.98.0 network: | Converts a record to url. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index 40976593a60..2ff8ebd64ea 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.97.1 +version: 0.98.0 network: | Parses a url. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index ce409db581d..a3bce532be2 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.97.1 +version: 0.98.0 core: | Use definitions from a module, making them available in your shell. usage: | diff --git a/commands/docs/values.md b/commands/docs/values.md index d9de1b69896..740f6c65662 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.97.1 +version: 0.98.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 03fc23f4712..41e5ea8d3fa 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.97.1 +version: 0.98.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index b817519a190..490a1ad6bf5 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | Various commands for viewing debug information. usage: | @@ -30,7 +30,7 @@ You must use one of the following subcommands. Using this command as-is will onl ## Subcommands: -| name | usage | type | +| name | description | type | | ---------------------------------------------- | ---------------------------------------------------------- | -------- | | [`view files`](/commands/docs/view_files.md) | View the files registered in nushell's EngineState memory. | built-in | | [`view ir`](/commands/docs/view_ir.md) | View the compiled IR code for a block of code. | built-in | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 2e0e271413f..b28e34b8588 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | View the files registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_ir.md b/commands/docs/view_ir.md index a43c412ce3e..1a3e03afe1a 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | View the compiled IR code for a block of code. usage: | diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index 8114a76d60e..200ecc83667 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | View a block, module, or a definition. usage: | diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index a88de06c943..d7bc71b8e1c 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.97.1 +version: 0.98.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index 0fa551b6aac..82e083ebb7c 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.97.1 +version: 0.98.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 fe222b2baa9..1c8a33f8242 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Filter values based on a row condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index 2c9ae6c27d7..9a75f1b966e 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.97.1 +version: 0.98.0 system: | Finds a program file, alias or custom command. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index fb42e621d55..f0897c756c9 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.97.1 +version: 0.98.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 83082c76747..96aed15d1c7 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.97.1 +version: 0.98.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index eabed4f08ac..7994d98a1c4 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.97.1 +version: 0.98.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 19ebb63b792..b9cbb38979f 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.97.1 +version: 0.98.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index ede649ea385..62e84dae01f 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 234c430af6f..49cc49427fb 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.97.1 +version: 0.98.0 filters: | Combine a stream with the input. usage: |