From 60026a02b05b460286c6b4c599f462c3d49ae412 Mon Sep 17 00:00:00 2001 From: hustcer Date: Fri, 25 Sep 2026 09:34:14 +0800 Subject: [PATCH 1/2] Refresh command docs for v0.116.0 --- commands/docs/abbr.md | 2 +- commands/docs/abbr_list.md | 2 +- commands/docs/alias.md | 2 +- commands/docs/all.md | 2 +- commands/docs/ansi.md | 2 +- 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/attr.md | 3 +- commands/docs/attr_category.md | 2 +- commands/docs/attr_complete.md | 6 +- commands/docs/attr_complete_external.md | 2 +- commands/docs/attr_deprecated.md | 2 +- commands/docs/attr_example.md | 2 +- commands/docs/attr_interactive.md | 49 ++++++++++ commands/docs/attr_search-terms.md | 2 +- commands/docs/banner.md | 5 +- commands/docs/bits.md | 2 +- 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 | 2 +- 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_split.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/chunk-by.md | 6 +- commands/docs/chunks.md | 2 +- commands/docs/clear.md | 2 +- commands/docs/collect.md | 2 +- commands/docs/columns.md | 2 +- commands/docs/combinations.md | 2 +- commands/docs/commandline.md | 2 +- commands/docs/commandline_complete.md | 36 ++++++-- commands/docs/commandline_edit.md | 2 +- commands/docs/commandline_get-cursor.md | 2 +- commands/docs/commandline_set-cursor.md | 2 +- commands/docs/commandline_set-prompt.md | 2 +- commands/docs/compact.md | 2 +- commands/docs/complete.md | 2 +- commands/docs/config.md | 2 +- commands/docs/config_env.md | 2 +- commands/docs/config_flatten.md | 2 +- commands/docs/config_nu.md | 2 +- commands/docs/config_reset.md | 2 +- commands/docs/config_use-colors.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_from-human.md | 2 +- commands/docs/date_humanize.md | 2 +- commands/docs/date_list-timezone.md | 24 ++--- commands/docs/date_now.md | 2 +- commands/docs/date_to-timezone.md | 2 +- commands/docs/debug.md | 2 +- commands/docs/debug_env.md | 2 +- commands/docs/debug_experimental-options.md | 2 +- commands/docs/debug_info.md | 2 +- commands/docs/debug_profile.md | 2 +- commands/docs/decode.md | 2 +- commands/docs/decode_base32.md | 2 +- commands/docs/decode_base32hex.md | 2 +- commands/docs/decode_base64.md | 2 +- commands/docs/decode_hex.md | 2 +- commands/docs/def.md | 2 +- commands/docs/default.md | 15 +++- commands/docs/describe.md | 2 +- commands/docs/detect.md | 2 +- commands/docs/detect_columns.md | 2 +- commands/docs/detect_type.md | 2 +- commands/docs/difference.md | 2 +- commands/docs/do.md | 2 +- commands/docs/drop.md | 2 +- commands/docs/drop_column.md | 2 +- commands/docs/drop_nth.md | 2 +- commands/docs/du.md | 2 +- commands/docs/each.md | 48 ++++++---- commands/docs/each_while.md | 2 +- commands/docs/echo.md | 2 +- commands/docs/encode.md | 2 +- commands/docs/encode_base32.md | 2 +- commands/docs/encode_base32hex.md | 2 +- commands/docs/encode_base64.md | 2 +- commands/docs/encode_hex.md | 2 +- commands/docs/enumerate.md | 2 +- commands/docs/error.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/explore_config.md | 2 +- commands/docs/explore_regex.md | 2 +- commands/docs/export-env.md | 2 +- commands/docs/export.md | 2 +- commands/docs/export_alias.md | 2 +- commands/docs/export_const.md | 2 +- commands/docs/export_def.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 | 19 +++- commands/docs/for.md | 2 +- commands/docs/format.md | 2 +- commands/docs/format_bits.md | 2 +- commands/docs/format_date.md | 2 +- commands/docs/format_duration.md | 2 +- commands/docs/format_filesize.md | 2 +- commands/docs/format_number.md | 2 +- commands/docs/format_pattern.md | 2 +- commands/docs/from.md | 2 +- commands/docs/from_csv.md | 2 +- commands/docs/from_eml.md | 2 +- commands/docs/from_ics.md | 18 ++-- commands/docs/from_ini.md | 2 +- commands/docs/from_json.md | 2 +- commands/docs/from_kdl.md | 85 ++++-------------- commands/docs/from_md.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/generate.md | 2 +- commands/docs/get.md | 2 +- commands/docs/glob.md | 2 +- commands/docs/grid.md | 2 +- commands/docs/group-by.md | 2 +- commands/docs/gstat.md | 2 +- commands/docs/hash.md | 5 +- commands/docs/hash_md5.md | 2 +- commands/docs/hash_sha256.md | 2 +- commands/docs/hash_sha512.md | 89 +++++++++++++++++++ commands/docs/headers.md | 2 +- commands/docs/help.md | 2 +- commands/docs/help_aliases.md | 2 +- commands/docs/help_commands.md | 2 +- commands/docs/help_escapes.md | 2 +- commands/docs/help_externs.md | 2 +- commands/docs/help_modules.md | 2 +- commands/docs/help_operators.md | 2 +- commands/docs/help_pipe-and-redirect.md | 2 +- commands/docs/hide-env.md | 2 +- commands/docs/hide.md | 2 +- commands/docs/histogram.md | 2 +- commands/docs/history.md | 2 +- commands/docs/history_import.md | 2 +- commands/docs/history_session.md | 2 +- commands/docs/http.md | 2 +- commands/docs/http_delete.md | 2 +- commands/docs/http_get.md | 2 +- commands/docs/http_head.md | 2 +- commands/docs/http_options.md | 2 +- commands/docs/http_patch.md | 2 +- commands/docs/http_pool.md | 2 +- commands/docs/http_post.md | 2 +- commands/docs/http_put.md | 2 +- commands/docs/idx.md | 2 +- commands/docs/idx_dirs.md | 2 +- commands/docs/idx_drop.md | 2 +- commands/docs/idx_files.md | 2 +- commands/docs/idx_find.md | 2 +- commands/docs/idx_init.md | 2 +- commands/docs/idx_search.md | 2 +- commands/docs/idx_status.md | 2 +- commands/docs/idx_watch.md | 2 +- commands/docs/if.md | 2 +- commands/docs/ignore.md | 2 +- commands/docs/inc.md | 2 +- commands/docs/input.md | 2 +- commands/docs/input_list.md | 2 +- commands/docs/input_listen.md | 2 +- commands/docs/insert.md | 2 +- commands/docs/inspect.md | 2 +- commands/docs/interleave.md | 2 +- commands/docs/intersect.md | 2 +- commands/docs/into.md | 2 +- commands/docs/into_binary.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_matrix.md | 2 +- commands/docs/into_record.md | 2 +- commands/docs/into_semver-range.md | 2 +- commands/docs/into_semver.md | 2 +- commands/docs/into_sqlite.md | 2 +- commands/docs/into_string.md | 42 +++++---- 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-redirected.md | 2 +- commands/docs/is-terminal.md | 2 +- commands/docs/items.md | 2 +- commands/docs/job.md | 2 +- commands/docs/job_describe.md | 2 +- commands/docs/job_flush.md | 2 +- commands/docs/job_id.md | 2 +- commands/docs/job_kill.md | 2 +- commands/docs/job_list.md | 2 +- commands/docs/job_recv.md | 2 +- commands/docs/job_send.md | 2 +- commands/docs/job_spawn.md | 2 +- commands/docs/job_unfreeze.md | 2 +- commands/docs/join.md | 2 +- commands/docs/keybindings.md | 2 +- commands/docs/keybindings_default.md | 2 +- commands/docs/keybindings_list.md | 2 +- commands/docs/keybindings_listen.md | 2 +- commands/docs/kill.md | 2 +- commands/docs/last.md | 2 +- commands/docs/length.md | 2 +- commands/docs/let-env.md | 2 +- commands/docs/let.md | 2 +- commands/docs/lines.md | 12 ++- commands/docs/load-env.md | 15 +++- commands/docs/loop.md | 2 +- commands/docs/ls.md | 2 +- commands/docs/match.md | 2 +- commands/docs/math.md | 2 +- commands/docs/math_abs.md | 2 +- commands/docs/math_arccos.md | 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_cbrt.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/matrix.md | 2 +- commands/docs/matrix_add.md | 2 +- commands/docs/matrix_get-col.md | 2 +- commands/docs/matrix_get-row.md | 2 +- commands/docs/matrix_identity.md | 2 +- commands/docs/matrix_into-nu.md | 2 +- commands/docs/matrix_map.md | 2 +- commands/docs/matrix_max.md | 2 +- commands/docs/matrix_mean.md | 2 +- commands/docs/matrix_multiply.md | 2 +- commands/docs/matrix_reduce.md | 2 +- commands/docs/matrix_reshape.md | 2 +- commands/docs/matrix_scale.md | 2 +- commands/docs/matrix_set-col.md | 2 +- commands/docs/matrix_set-row.md | 2 +- commands/docs/matrix_subtract.md | 2 +- commands/docs/matrix_sum.md | 2 +- commands/docs/matrix_transpose.md | 2 +- commands/docs/matrix_zeros.md | 2 +- commands/docs/merge.md | 2 +- commands/docs/merge_deep.md | 2 +- commands/docs/metadata.md | 2 +- commands/docs/metadata_access.md | 2 +- commands/docs/metadata_set.md | 2 +- commands/docs/mkdir.md | 17 ++-- 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/nu-check.md | 2 +- commands/docs/nu-highlight.md | 2 +- commands/docs/open.md | 2 +- commands/docs/overlay.md | 2 +- commands/docs/overlay_hide.md | 2 +- commands/docs/overlay_list.md | 2 +- commands/docs/overlay_new.md | 2 +- commands/docs/overlay_use.md | 2 +- commands/docs/panic.md | 2 +- commands/docs/par-each.md | 4 +- commands/docs/parse.md | 2 +- commands/docs/path.md | 2 +- commands/docs/path_basename.md | 2 +- commands/docs/path_dirname.md | 2 +- commands/docs/path_exists.md | 2 +- commands/docs/path_expand.md | 2 +- commands/docs/path_join.md | 2 +- commands/docs/path_parse.md | 2 +- commands/docs/path_relative-to.md | 2 +- commands/docs/path_self.md | 2 +- commands/docs/path_split.md | 2 +- commands/docs/path_type.md | 2 +- commands/docs/peek.md | 2 +- commands/docs/permutations.md | 2 +- commands/docs/plugin.md | 2 +- commands/docs/plugin_add.md | 2 +- commands/docs/plugin_list.md | 22 +++-- commands/docs/plugin_rm.md | 2 +- commands/docs/plugin_stop.md | 2 +- commands/docs/plugin_use.md | 2 +- commands/docs/polars.md | 6 +- commands/docs/polars_agg-groups.md | 2 +- commands/docs/polars_agg.md | 2 +- 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 | 2 +- commands/docs/polars_cast.md | 2 +- commands/docs/polars_col.md | 2 +- commands/docs/polars_collect.md | 2 +- commands/docs/polars_columns.md | 2 +- commands/docs/polars_concat-str.md | 2 +- commands/docs/polars_concat.md | 2 +- commands/docs/polars_contains.md | 2 +- commands/docs/polars_convert-time-zone.md | 2 +- commands/docs/polars_count-null.md | 2 +- commands/docs/polars_count.md | 2 +- commands/docs/polars_cumulative.md | 2 +- commands/docs/polars_cut.md | 2 +- commands/docs/polars_date-range.md | 88 ++++++++++++++++++ commands/docs/polars_date-ranges.md | 87 ++++++++++++++++++ commands/docs/polars_datepart.md | 30 ++----- commands/docs/polars_datetime-range.md | 88 ++++++++++++++++++ commands/docs/polars_datetime-ranges.md | 89 +++++++++++++++++++ commands/docs/polars_decimal.md | 2 +- commands/docs/polars_drop-duplicates.md | 2 +- commands/docs/polars_drop-nulls.md | 2 +- commands/docs/polars_drop.md | 2 +- commands/docs/polars_dummies.md | 2 +- commands/docs/polars_entropy.md | 2 +- commands/docs/polars_explode.md | 2 +- commands/docs/polars_expr-not.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 | 2 +- commands/docs/polars_horizontal.md | 2 +- commands/docs/polars_implode.md | 2 +- commands/docs/polars_integer.md | 2 +- commands/docs/polars_into-df.md | 2 +- commands/docs/polars_into-dtype.md | 2 +- commands/docs/polars_into-lazy.md | 2 +- commands/docs/polars_into-nu.md | 2 +- commands/docs/polars_into-repr.md | 2 +- commands/docs/polars_into-schema.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-where.md | 2 +- commands/docs/polars_join.md | 2 +- commands/docs/polars_last.md | 2 +- commands/docs/polars_len.md | 2 +- commands/docs/polars_list-contains.md | 2 +- commands/docs/polars_lit.md | 2 +- commands/docs/polars_lowercase.md | 2 +- commands/docs/polars_map-batches.md | 2 +- commands/docs/polars_math.md | 2 +- commands/docs/polars_math_abs.md | 2 +- commands/docs/polars_math_bitwise-and.md | 2 +- .../docs/polars_math_bitwise-count-ones.md | 2 +- .../docs/polars_math_bitwise-count-zeros.md | 2 +- .../docs/polars_math_bitwise-leading-ones.md | 2 +- .../docs/polars_math_bitwise-leading-zeros.md | 2 +- commands/docs/polars_math_bitwise-or.md | 2 +- .../docs/polars_math_bitwise-trailing-ones.md | 2 +- .../polars_math_bitwise-trailing-zeros.md | 2 +- commands/docs/polars_math_bitwise-xor.md | 2 +- commands/docs/polars_math_cos.md | 2 +- commands/docs/polars_math_dot.md | 2 +- commands/docs/polars_math_exp.md | 2 +- commands/docs/polars_math_log.md | 2 +- commands/docs/polars_math_log1p.md | 2 +- commands/docs/polars_math_sign.md | 2 +- commands/docs/polars_math_sin.md | 2 +- commands/docs/polars_math_sqrt.md | 2 +- commands/docs/polars_max.md | 2 +- commands/docs/polars_mean.md | 2 +- commands/docs/polars_median.md | 2 +- commands/docs/polars_min.md | 2 +- 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_over.md | 2 +- commands/docs/polars_pivot.md | 2 +- commands/docs/polars_profile.md | 2 +- commands/docs/polars_qcut.md | 2 +- commands/docs/polars_quantile.md | 2 +- commands/docs/polars_query.md | 2 +- commands/docs/polars_rename.md | 2 +- commands/docs/polars_replace-time-zone.md | 2 +- commands/docs/polars_replace.md | 2 +- commands/docs/polars_reverse.md | 2 +- 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_selector.md | 2 +- commands/docs/polars_selector_all.md | 2 +- commands/docs/polars_selector_alpha.md | 2 +- commands/docs/polars_selector_alphanumeric.md | 2 +- commands/docs/polars_selector_array.md | 2 +- commands/docs/polars_selector_binary.md | 2 +- commands/docs/polars_selector_boolean.md | 2 +- commands/docs/polars_selector_by-dtype.md | 2 +- commands/docs/polars_selector_by-index.md | 2 +- commands/docs/polars_selector_by-name.md | 2 +- commands/docs/polars_selector_categorical.md | 2 +- commands/docs/polars_selector_contains.md | 2 +- commands/docs/polars_selector_date.md | 2 +- commands/docs/polars_selector_datetime.md | 2 +- commands/docs/polars_selector_decimal.md | 2 +- commands/docs/polars_selector_digit.md | 2 +- commands/docs/polars_selector_duration.md | 2 +- commands/docs/polars_selector_empty.md | 2 +- commands/docs/polars_selector_ends-with.md | 2 +- commands/docs/polars_selector_enum.md | 2 +- commands/docs/polars_selector_exclude.md | 2 +- commands/docs/polars_selector_first.md | 2 +- commands/docs/polars_selector_float.md | 2 +- commands/docs/polars_selector_integer.md | 2 +- commands/docs/polars_selector_last.md | 2 +- commands/docs/polars_selector_list.md | 2 +- commands/docs/polars_selector_matches.md | 2 +- commands/docs/polars_selector_nested.md | 2 +- commands/docs/polars_selector_not.md | 2 +- commands/docs/polars_selector_numeric.md | 2 +- commands/docs/polars_selector_object.md | 2 +- .../docs/polars_selector_signed-integer.md | 2 +- commands/docs/polars_selector_starts-with.md | 2 +- commands/docs/polars_selector_string.md | 2 +- commands/docs/polars_selector_struct.md | 2 +- commands/docs/polars_selector_temporal.md | 2 +- .../docs/polars_selector_unsigned-integer.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 | 2 +- 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 | 2 +- commands/docs/polars_str-lengths.md | 2 +- commands/docs/polars_str-replace-all.md | 2 +- commands/docs/polars_str-replace.md | 2 +- commands/docs/polars_str-slice.md | 2 +- commands/docs/polars_str-split.md | 2 +- commands/docs/polars_str-strip-chars.md | 2 +- commands/docs/polars_strftime.md | 2 +- commands/docs/polars_struct-json-encode.md | 2 +- commands/docs/polars_sum.md | 2 +- commands/docs/polars_summary.md | 2 +- commands/docs/polars_take.md | 2 +- commands/docs/polars_truncate.md | 4 +- commands/docs/polars_unique.md | 2 +- commands/docs/polars_unnest.md | 2 +- commands/docs/polars_unpivot.md | 2 +- commands/docs/polars_uppercase.md | 2 +- commands/docs/polars_value-counts.md | 2 +- commands/docs/polars_var.md | 2 +- 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 | 2 +- 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 | 2 +- commands/docs/random_binary.md | 2 +- commands/docs/random_bool.md | 2 +- commands/docs/random_chars.md | 2 +- commands/docs/random_float.md | 2 +- commands/docs/random_int.md | 2 +- commands/docs/random_pass.md | 2 +- commands/docs/random_uuid.md | 2 +- commands/docs/reduce.md | 2 +- commands/docs/registry.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 | 2 +- commands/docs/roll_down.md | 2 +- commands/docs/roll_left.md | 2 +- commands/docs/roll_right.md | 2 +- commands/docs/roll_up.md | 2 +- commands/docs/rotate.md | 2 +- commands/docs/run-external.md | 2 +- commands/docs/run-internal.md | 2 +- commands/docs/run.md | 2 +- commands/docs/save.md | 4 +- commands/docs/schema.md | 2 +- commands/docs/scope.md | 2 +- commands/docs/scope_aliases.md | 2 +- commands/docs/scope_commands.md | 2 +- commands/docs/scope_engine-stats.md | 2 +- commands/docs/scope_externs.md | 2 +- commands/docs/scope_modules.md | 2 +- commands/docs/scope_variables.md | 2 +- commands/docs/select.md | 2 +- commands/docs/semver.md | 2 +- commands/docs/semver_bump.md | 2 +- commands/docs/seq.md | 2 +- commands/docs/seq_char.md | 2 +- commands/docs/seq_date.md | 2 +- commands/docs/shuffle.md | 2 +- commands/docs/skip.md | 2 +- commands/docs/skip_until.md | 6 +- commands/docs/skip_while.md | 6 +- commands/docs/sleep.md | 2 +- commands/docs/slice.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.md | 2 +- commands/docs/split_cell-path.md | 2 +- commands/docs/split_chars.md | 2 +- commands/docs/split_column.md | 2 +- 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 | 2 +- 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 | 2 +- commands/docs/str_camel-case.md | 2 +- commands/docs/str_capitalize.md | 2 +- commands/docs/str_contains.md | 2 +- commands/docs/str_distance.md | 2 +- commands/docs/str_downcase.md | 2 +- commands/docs/str_ends-with.md | 2 +- commands/docs/str_escape-regex.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_lowercase.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/str_uppercase.md | 2 +- commands/docs/sys.md | 2 +- 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 | 2 +- commands/docs/take_until.md | 6 +- commands/docs/take_while.md | 6 +- commands/docs/tee.md | 2 +- commands/docs/term.md | 2 +- commands/docs/term_query.md | 2 +- commands/docs/term_size.md | 2 +- commands/docs/timeit.md | 2 +- commands/docs/to.md | 2 +- commands/docs/to_csv.md | 2 +- commands/docs/to_html.md | 2 +- commands/docs/to_json.md | 2 +- commands/docs/to_kdl.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_txt.md | 2 +- commands/docs/to_xml.md | 2 +- commands/docs/to_yaml.md | 6 +- commands/docs/to_yml.md | 6 +- commands/docs/touch.md | 2 +- commands/docs/transpose.md | 2 +- commands/docs/try.md | 2 +- commands/docs/tui.md | 72 +++++++++++++++ commands/docs/tui_bind.md | 65 ++++++++++++++ commands/docs/tui_box.md | 54 +++++++++++ commands/docs/tui_button.md | 60 +++++++++++++ commands/docs/tui_debug.md | 80 +++++++++++++++++ commands/docs/tui_label.md | 71 +++++++++++++++ commands/docs/tui_log.md | 58 ++++++++++++ commands/docs/tui_menu.md | 65 ++++++++++++++ commands/docs/tui_preview.md | 67 ++++++++++++++ commands/docs/tui_progress.md | 66 ++++++++++++++ commands/docs/tui_run.md | 81 +++++++++++++++++ commands/docs/tui_search.md | 64 +++++++++++++ commands/docs/tui_select.md | 67 ++++++++++++++ commands/docs/tui_split.md | 70 +++++++++++++++ commands/docs/tui_tab.md | 58 ++++++++++++ commands/docs/tui_table.md | 82 +++++++++++++++++ commands/docs/tui_textbox.md | 51 +++++++++++ commands/docs/tui_tree.md | 65 ++++++++++++++ commands/docs/tutor.md | 2 +- commands/docs/ulimit.md | 2 +- commands/docs/umask.md | 2 +- commands/docs/uname.md | 2 +- commands/docs/union.md | 2 +- commands/docs/uniq-by.md | 2 +- commands/docs/uniq.md | 2 +- commands/docs/unlet.md | 2 +- commands/docs/update.md | 2 +- commands/docs/update_cells.md | 22 ++++- commands/docs/upsert.md | 2 +- commands/docs/url.md | 2 +- 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/url_split-query.md | 2 +- commands/docs/use.md | 2 +- commands/docs/values.md | 2 +- commands/docs/version.md | 2 +- commands/docs/version_check.md | 2 +- commands/docs/view.md | 2 +- commands/docs/view_blocks.md | 2 +- commands/docs/view_files.md | 2 +- commands/docs/view_ir.md | 2 +- commands/docs/view_source.md | 31 ++++++- 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 +- 739 files changed, 2668 insertions(+), 905 deletions(-) create mode 100644 commands/docs/attr_interactive.md create mode 100644 commands/docs/hash_sha512.md create mode 100644 commands/docs/polars_date-range.md create mode 100644 commands/docs/polars_date-ranges.md create mode 100644 commands/docs/polars_datetime-range.md create mode 100644 commands/docs/polars_datetime-ranges.md create mode 100644 commands/docs/tui.md create mode 100644 commands/docs/tui_bind.md create mode 100644 commands/docs/tui_box.md create mode 100644 commands/docs/tui_button.md create mode 100644 commands/docs/tui_debug.md create mode 100644 commands/docs/tui_label.md create mode 100644 commands/docs/tui_log.md create mode 100644 commands/docs/tui_menu.md create mode 100644 commands/docs/tui_preview.md create mode 100644 commands/docs/tui_progress.md create mode 100644 commands/docs/tui_run.md create mode 100644 commands/docs/tui_search.md create mode 100644 commands/docs/tui_select.md create mode 100644 commands/docs/tui_split.md create mode 100644 commands/docs/tui_tab.md create mode 100644 commands/docs/tui_table.md create mode 100644 commands/docs/tui_textbox.md create mode 100644 commands/docs/tui_tree.md diff --git a/commands/docs/abbr.md b/commands/docs/abbr.md index 3994d601116..84b909faa55 100644 --- a/commands/docs/abbr.md +++ b/commands/docs/abbr.md @@ -2,7 +2,7 @@ title: abbr categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Abbreviations related commands. usage: | diff --git a/commands/docs/abbr_list.md b/commands/docs/abbr_list.md index 23426081e44..ac4ab8d2f96 100644 --- a/commands/docs/abbr_list.md +++ b/commands/docs/abbr_list.md @@ -2,7 +2,7 @@ title: abbr list categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | List all defined abbreviations. usage: | diff --git a/commands/docs/alias.md b/commands/docs/alias.md index c6d85809ab5..66d280af7c9 100644 --- a/commands/docs/alias.md +++ b/commands/docs/alias.md @@ -2,7 +2,7 @@ title: alias categories: | core -version: 0.115.1 +version: 0.116.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 9ab967b231d..dea492ed399 100644 --- a/commands/docs/all.md +++ b/commands/docs/all.md @@ -2,7 +2,7 @@ title: all categories: | filters -version: 0.115.1 +version: 0.116.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 4aa45ede4ee..a9cc1ee0404 100644 --- a/commands/docs/ansi.md +++ b/commands/docs/ansi.md @@ -2,7 +2,7 @@ title: ansi categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Output ANSI codes to change color and style of text. usage: | diff --git a/commands/docs/ansi_gradient.md b/commands/docs/ansi_gradient.md index 520cfa4b3ea..54d4bba54a0 100644 --- a/commands/docs/ansi_gradient.md +++ b/commands/docs/ansi_gradient.md @@ -2,7 +2,7 @@ title: ansi gradient categories: | platform -version: 0.115.1 +version: 0.116.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 f52364a85e8..b7bdf075217 100644 --- a/commands/docs/ansi_link.md +++ b/commands/docs/ansi_link.md @@ -2,7 +2,7 @@ title: ansi link categories: | platform -version: 0.115.1 +version: 0.116.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 a97daa1175e..67f0671b242 100644 --- a/commands/docs/ansi_strip.md +++ b/commands/docs/ansi_strip.md @@ -2,7 +2,7 @@ title: ansi strip categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Strip ANSI escape sequences from a string. usage: | diff --git a/commands/docs/any.md b/commands/docs/any.md index 1476daf23b1..0fb09d2615f 100644 --- a/commands/docs/any.md +++ b/commands/docs/any.md @@ -2,7 +2,7 @@ title: any categories: | filters -version: 0.115.1 +version: 0.116.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 7b7bba1397f..97a759159f3 100644 --- a/commands/docs/append.md +++ b/commands/docs/append.md @@ -2,7 +2,7 @@ title: append categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Append any number of rows to a table. usage: | diff --git a/commands/docs/ast.md b/commands/docs/ast.md index 21024e74ebd..37d4334d64a 100644 --- a/commands/docs/ast.md +++ b/commands/docs/ast.md @@ -2,7 +2,7 @@ title: ast categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Print the abstract syntax tree (ast) for a pipeline. usage: | diff --git a/commands/docs/attr.md b/commands/docs/attr.md index 0c61a016fcf..dc5b15c8456 100644 --- a/commands/docs/attr.md +++ b/commands/docs/attr.md @@ -2,7 +2,7 @@ title: attr categories: | core -version: 0.115.1 +version: 0.116.0 core: | Various attributes for custom commands. usage: | @@ -42,4 +42,5 @@ You must use one of the following subcommands. Using this command as-is will onl | [`attr complete external`](/commands/docs/attr_complete_external.md) | Attribute for enabling use of the external completer for internal commands. | built-in | | [`attr deprecated`](/commands/docs/attr_deprecated.md) | Attribute for marking a command or flag as deprecated. | built-in | | [`attr example`](/commands/docs/attr_example.md) | Attribute for adding examples to custom commands. | built-in | +| [`attr interactive`](/commands/docs/attr_interactive.md) | Attribute marking a completer as interactive. | built-in | | [`attr search-terms`](/commands/docs/attr_search-terms.md) | Attribute for adding search terms to custom commands. | built-in | \ No newline at end of file diff --git a/commands/docs/attr_category.md b/commands/docs/attr_category.md index a96540edcd2..8da55d31218 100644 --- a/commands/docs/attr_category.md +++ b/commands/docs/attr_category.md @@ -2,7 +2,7 @@ title: attr category categories: | core -version: 0.115.1 +version: 0.116.0 core: | Attribute for adding a category to custom commands. usage: | diff --git a/commands/docs/attr_complete.md b/commands/docs/attr_complete.md index ca0d62a05be..105acab7d8d 100644 --- a/commands/docs/attr_complete.md +++ b/commands/docs/attr_complete.md @@ -2,7 +2,7 @@ title: attr complete categories: | core -version: 0.115.1 +version: 0.116.0 core: | Attribute for using another command as a completion source for all arguments. usage: | @@ -38,8 +38,8 @@ contributors: false Use another command as completion source. ```nu -> def complete-foo [spans: list] { - [bar baz qux spam eggs] | where $it not-in $spans +> def complete-foo [token: record] { + [bar baz qux spam eggs] | where $it != $token.text } @complete 'complete-foo' diff --git a/commands/docs/attr_complete_external.md b/commands/docs/attr_complete_external.md index aa6f55c69d6..44026f7cba5 100644 --- a/commands/docs/attr_complete_external.md +++ b/commands/docs/attr_complete_external.md @@ -2,7 +2,7 @@ title: attr complete external categories: | core -version: 0.115.1 +version: 0.116.0 core: | Attribute for enabling use of the external completer for internal commands. usage: | diff --git a/commands/docs/attr_deprecated.md b/commands/docs/attr_deprecated.md index 60e1860fd21..bf852223b1a 100644 --- a/commands/docs/attr_deprecated.md +++ b/commands/docs/attr_deprecated.md @@ -2,7 +2,7 @@ title: attr deprecated categories: | core -version: 0.115.1 +version: 0.116.0 core: | Attribute for marking a command or flag as deprecated. usage: | diff --git a/commands/docs/attr_example.md b/commands/docs/attr_example.md index ba3ea8083ed..7fec6de289f 100644 --- a/commands/docs/attr_example.md +++ b/commands/docs/attr_example.md @@ -2,7 +2,7 @@ title: attr example categories: | core -version: 0.115.1 +version: 0.116.0 core: | Attribute for adding examples to custom commands. usage: | diff --git a/commands/docs/attr_interactive.md b/commands/docs/attr_interactive.md new file mode 100644 index 00000000000..71fff847806 --- /dev/null +++ b/commands/docs/attr_interactive.md @@ -0,0 +1,49 @@ +--- +title: attr interactive +categories: | + core +version: 0.116.0 +core: | + Attribute marking a completer as interactive. +usage: | + Attribute marking a completer as interactive. +editLink: false +contributors: false +--- + + +# `attr interactive` for [core](/commands/categories/core.md) + +
Attribute marking a completer as interactive.
+ +## Command Type + +`built-in` + +## Signature + +```> attr interactive {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | bool | +## Examples + +Drive a terminal picker from a completer, then attach it to an argument. +```nu +> @interactive +def pick-file [token: record] { + ls | get name | to text | ^fzf --query $token.text | lines +} + +def open-file [path: string@pick-file] { open $path } + +``` + +## Notes +An interactive completer runs on the line-editor thread, with the terminal to itself, instead of on the background completion worker. This lets it drive a terminal picker such as `fzf` or `input list`, which need stdin and the TTY. Every other completer stays on the worker, so it never blocks the line editor and its result can be cached; only completers that must own the terminal should opt in. + +The attribute only chooses where a completer runs; it does not make the command one. Attach it as usual, `arg: type@name` or `@complete 'name'`; and the completion engine calls it with the `token` record when you press Tab. Called directly it is an ordinary command, so declare `token: record`: that way `pick-file foo` is rejected at the call site instead of failing deep inside the body on `$token.text`. To try a completer by hand, get a real record from `commandline complete --input`. \ No newline at end of file diff --git a/commands/docs/attr_search-terms.md b/commands/docs/attr_search-terms.md index e2ad2850e59..b60a990198d 100644 --- a/commands/docs/attr_search-terms.md +++ b/commands/docs/attr_search-terms.md @@ -2,7 +2,7 @@ title: attr search-terms categories: | core -version: 0.115.1 +version: 0.116.0 core: | Attribute for adding search terms to custom commands. usage: | diff --git a/commands/docs/banner.md b/commands/docs/banner.md index fb59a0a2eb8..36a0ff93712 100644 --- a/commands/docs/banner.md +++ b/commands/docs/banner.md @@ -2,7 +2,7 @@ title: banner categories: | default -version: 0.115.1 +version: 0.116.0 default: | Print a banner for Nushell with information about the project usage: | @@ -26,4 +26,5 @@ contributors: false ## Flags - - `--short`: Only show startup time + - `--short`: Only show the startup time + - `--no-startup-time`: Show the welcome message without the startup time diff --git a/commands/docs/bits.md b/commands/docs/bits.md index fa95a5ac6fb..b13e3de5bf2 100644 --- a/commands/docs/bits.md +++ b/commands/docs/bits.md @@ -2,7 +2,7 @@ title: bits categories: | bits -version: 0.115.1 +version: 0.116.0 bits: | Various commands for working with bits. usage: | diff --git a/commands/docs/bits_and.md b/commands/docs/bits_and.md index f6f7c1545e6..5af3406a0e6 100644 --- a/commands/docs/bits_and.md +++ b/commands/docs/bits_and.md @@ -2,7 +2,7 @@ title: bits and categories: | bits -version: 0.115.1 +version: 0.116.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 6804fdfabd5..deb8f1ff327 100644 --- a/commands/docs/bits_not.md +++ b/commands/docs/bits_not.md @@ -2,7 +2,7 @@ title: bits not categories: | bits -version: 0.115.1 +version: 0.116.0 bits: | Performs logical negation on each bit. usage: | diff --git a/commands/docs/bits_or.md b/commands/docs/bits_or.md index 51179a20dd1..dda4408cc4f 100644 --- a/commands/docs/bits_or.md +++ b/commands/docs/bits_or.md @@ -2,7 +2,7 @@ title: bits or categories: | bits -version: 0.115.1 +version: 0.116.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 0da2b59930a..dd54ef1ed86 100644 --- a/commands/docs/bits_rol.md +++ b/commands/docs/bits_rol.md @@ -2,7 +2,7 @@ title: bits rol categories: | bits -version: 0.115.1 +version: 0.116.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 c08d029ff9f..53b77bb3cc0 100644 --- a/commands/docs/bits_ror.md +++ b/commands/docs/bits_ror.md @@ -2,7 +2,7 @@ title: bits ror categories: | bits -version: 0.115.1 +version: 0.116.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 97136495ac6..b0d923ae96f 100644 --- a/commands/docs/bits_shl.md +++ b/commands/docs/bits_shl.md @@ -2,7 +2,7 @@ title: bits shl categories: | bits -version: 0.115.1 +version: 0.116.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 001fc351ba8..fac74bfb2e6 100644 --- a/commands/docs/bits_shr.md +++ b/commands/docs/bits_shr.md @@ -2,7 +2,7 @@ title: bits shr categories: | bits -version: 0.115.1 +version: 0.116.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 90308d503f4..d2a45b1ec0a 100644 --- a/commands/docs/bits_xor.md +++ b/commands/docs/bits_xor.md @@ -2,7 +2,7 @@ title: bits xor categories: | bits -version: 0.115.1 +version: 0.116.0 bits: | Performs bitwise xor for ints or binary values. usage: | diff --git a/commands/docs/break.md b/commands/docs/break.md index 4f5f328946e..d543b052bac 100644 --- a/commands/docs/break.md +++ b/commands/docs/break.md @@ -2,7 +2,7 @@ title: break categories: | core -version: 0.115.1 +version: 0.116.0 core: | Break a loop. usage: | diff --git a/commands/docs/bytes.md b/commands/docs/bytes.md index 110e1f54162..bc31a211ac2 100644 --- a/commands/docs/bytes.md +++ b/commands/docs/bytes.md @@ -2,7 +2,7 @@ title: bytes categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Various commands for working with byte data. usage: | diff --git a/commands/docs/bytes_add.md b/commands/docs/bytes_add.md index 88a051a3501..17b0312be1a 100644 --- a/commands/docs/bytes_add.md +++ b/commands/docs/bytes_add.md @@ -2,7 +2,7 @@ title: bytes add categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Add specified bytes to the binary input. usage: | diff --git a/commands/docs/bytes_at.md b/commands/docs/bytes_at.md index 3ed216bf343..2e7810cb8f0 100644 --- a/commands/docs/bytes_at.md +++ b/commands/docs/bytes_at.md @@ -2,7 +2,7 @@ title: bytes at categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Get bytes from the input defined by a range. usage: | diff --git a/commands/docs/bytes_build.md b/commands/docs/bytes_build.md index 7227327c9f5..ac58387078d 100644 --- a/commands/docs/bytes_build.md +++ b/commands/docs/bytes_build.md @@ -2,7 +2,7 @@ title: bytes build categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Create a binary value from the provided arguments. usage: | diff --git a/commands/docs/bytes_collect.md b/commands/docs/bytes_collect.md index a7962ec34ae..61cf0c3bafd 100644 --- a/commands/docs/bytes_collect.md +++ b/commands/docs/bytes_collect.md @@ -2,7 +2,7 @@ title: bytes collect categories: | bytes -version: 0.115.1 +version: 0.116.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 a6677fcf400..3e7b1bcc184 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.115.1 +version: 0.116.0 bytes: | Check if binary data ends with a pattern. usage: | diff --git a/commands/docs/bytes_index-of.md b/commands/docs/bytes_index-of.md index 7e0d46b33c2..68c0cbd76c1 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.115.1 +version: 0.116.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 15c8784939a..82aac520e9d 100644 --- a/commands/docs/bytes_length.md +++ b/commands/docs/bytes_length.md @@ -2,7 +2,7 @@ title: bytes length categories: | bytes -version: 0.115.1 +version: 0.116.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 f43214d6917..c6f6001495d 100644 --- a/commands/docs/bytes_remove.md +++ b/commands/docs/bytes_remove.md @@ -2,7 +2,7 @@ title: bytes remove categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Remove specified bytes from the input. usage: | diff --git a/commands/docs/bytes_replace.md b/commands/docs/bytes_replace.md index 21386b6ce0e..5ae58b3d496 100644 --- a/commands/docs/bytes_replace.md +++ b/commands/docs/bytes_replace.md @@ -2,7 +2,7 @@ title: bytes replace categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Find and replace bytes in binary data. usage: | diff --git a/commands/docs/bytes_reverse.md b/commands/docs/bytes_reverse.md index aca5e1db6c5..40576280365 100644 --- a/commands/docs/bytes_reverse.md +++ b/commands/docs/bytes_reverse.md @@ -2,7 +2,7 @@ title: bytes reverse categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Reverse the bytes in the pipeline. usage: | diff --git a/commands/docs/bytes_split.md b/commands/docs/bytes_split.md index 02d42ddfb5a..4dc5c99fe66 100644 --- a/commands/docs/bytes_split.md +++ b/commands/docs/bytes_split.md @@ -2,7 +2,7 @@ title: bytes split categories: | bytes -version: 0.115.1 +version: 0.116.0 bytes: | Split input into multiple items using a separator. usage: | diff --git a/commands/docs/bytes_starts-with.md b/commands/docs/bytes_starts-with.md index 6632ddf3493..d54be034a57 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.115.1 +version: 0.116.0 bytes: | Check if binary data starts with a pattern. usage: | diff --git a/commands/docs/cal.md b/commands/docs/cal.md index 1220d9e1bef..1dc7a1896a6 100644 --- a/commands/docs/cal.md +++ b/commands/docs/cal.md @@ -2,7 +2,7 @@ title: cal categories: | generators -version: 0.115.1 +version: 0.116.0 generators: | Display a calendar. usage: | diff --git a/commands/docs/cd.md b/commands/docs/cd.md index 901c828885c..f656c3b7c8a 100644 --- a/commands/docs/cd.md +++ b/commands/docs/cd.md @@ -2,7 +2,7 @@ title: cd categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Change the current working directory. usage: | diff --git a/commands/docs/char.md b/commands/docs/char.md index 19afcd4f6a9..dde3853b7e6 100644 --- a/commands/docs/char.md +++ b/commands/docs/char.md @@ -2,7 +2,7 @@ title: char categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Output special characters (e.g., 'newline'). usage: | diff --git a/commands/docs/chunk-by.md b/commands/docs/chunk-by.md index f583c5ab7cf..f2972595d09 100644 --- a/commands/docs/chunk-by.md +++ b/commands/docs/chunk-by.md @@ -2,7 +2,7 @@ title: chunk-by categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Divides a sequence into sub-sequences based on a closure. usage: | @@ -39,7 +39,7 @@ contributors: false Chunk data into runs of larger than zero or not. ```nu -> [1, 3, -2, -2, 0, 1, 2] | chunk-by {|it| $it >= 0 } +> [1, 3, -2, -2, 0, 1, 2] | chunk-by $it >= 0 ╭───┬────────────╮ │ 0 │ ╭───┬───╮ │ │ │ │ 0 │ 1 │ │ @@ -60,7 +60,7 @@ Chunk data into runs of larger than zero or not. Identify repetitions in a string ```nu -> [a b b c c c] | chunk-by { |it| $it } +> [a b b c c c] | chunk-by $it ╭───┬───────────╮ │ 0 │ ╭───┬───╮ │ │ │ │ 0 │ a │ │ diff --git a/commands/docs/chunks.md b/commands/docs/chunks.md index f127a6e7970..966ad75875e 100644 --- a/commands/docs/chunks.md +++ b/commands/docs/chunks.md @@ -2,7 +2,7 @@ title: chunks categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Divide a list, table or binary input into chunks of `chunk_size`. For binary input, `chunk_size` can also be specified as a filesize. usage: | diff --git a/commands/docs/clear.md b/commands/docs/clear.md index 1b56d8d4608..ebb505f7a8a 100644 --- a/commands/docs/clear.md +++ b/commands/docs/clear.md @@ -2,7 +2,7 @@ title: clear categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Clear the terminal screen. usage: | diff --git a/commands/docs/collect.md b/commands/docs/collect.md index 1440a4710a5..9e403b8d32c 100644 --- a/commands/docs/collect.md +++ b/commands/docs/collect.md @@ -2,7 +2,7 @@ title: collect categories: | core -version: 0.115.1 +version: 0.116.0 core: | Collect a stream into a value. usage: | diff --git a/commands/docs/columns.md b/commands/docs/columns.md index 879d12ec773..9a20e452051 100644 --- a/commands/docs/columns.md +++ b/commands/docs/columns.md @@ -2,7 +2,7 @@ title: columns categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Given a record or table, produce a list of its columns' names. usage: | diff --git a/commands/docs/combinations.md b/commands/docs/combinations.md index 8d909cd6c2f..1bcab2a16d5 100644 --- a/commands/docs/combinations.md +++ b/commands/docs/combinations.md @@ -2,7 +2,7 @@ title: combinations categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Generates all combinations of size k from the input list. usage: | diff --git a/commands/docs/commandline.md b/commands/docs/commandline.md index 9ed5395fecc..23c078df5f3 100644 --- a/commands/docs/commandline.md +++ b/commands/docs/commandline.md @@ -2,7 +2,7 @@ title: commandline categories: | core -version: 0.115.1 +version: 0.116.0 core: | View the current command line input buffer. usage: | diff --git a/commands/docs/commandline_complete.md b/commands/docs/commandline_complete.md index aa681aae21a..a7c8928bf5f 100644 --- a/commands/docs/commandline_complete.md +++ b/commands/docs/commandline_complete.md @@ -2,7 +2,7 @@ title: commandline complete categories: | core -version: 0.115.1 +version: 0.116.0 core: | Complete a string using the default completions. usage: | @@ -27,15 +27,16 @@ contributors: false ## Flags - `--detailed, -d`: Output completions as records, in the format expected from custom completers. - - `--type {string}`: The type of values to allow as completions. + - `--input, -i`: Output the record a completer would receive here (`{token, place, buffer}`), instead of completions. + - `--type {string}`: Restrict completions to one built-in source (directory, path, glob, command, variable, or env-var), so a completer can compose the engine's own sources with its results. ## Input/output types: -| input | output | -| ------- | --------------------------------- | -| nothing | oneof<list<string>, list<record>> | -| string | oneof<list<string>, list<record>> | +| input | output | +| ------- | ----------------------------------------- | +| nothing | oneof<list<string>, list<record>, record> | +| string | oneof<list<string>, list<record>, record> | ## Examples List completions for command names. @@ -70,8 +71,29 @@ Extend builtin completions for the current commandline. ``` +Compose a built-in source inside a completer: the engine's command names beside your own. +```nu +> def comp [token: record] { [my-alias] ++ ($token.text | commandline complete --type command) } + +``` + +Return `fallback: true` to add completions beside the built-in ones rather than replacing them. +```nu +> def comp [token: record] { {completions: [my-preset], fallback: true} } + +``` + +Inspect what a completer would be handed at the cursor, including the argument's declared shape. +```nu +> 'cd ma' | commandline complete --input | get place.shape + +``` + ## Notes This command can be used to obtain the completions that Nushell would normally provide for the given commandline contents. Completions will be provided as if the cursor is placed at the end of the given string. -If no input is provided, the current commandline contents will be used instead. \ No newline at end of file +If no input is provided, the current commandline contents will be used instead. + +With --input, the record a completer would receive at that position is returned instead of +completions, which is the supported way to develop and test a completer from inside Nushell. \ No newline at end of file diff --git a/commands/docs/commandline_edit.md b/commands/docs/commandline_edit.md index d23eab913b8..973d7de148f 100644 --- a/commands/docs/commandline_edit.md +++ b/commands/docs/commandline_edit.md @@ -2,7 +2,7 @@ title: commandline edit categories: | core -version: 0.115.1 +version: 0.116.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 00df305035a..d417b2d7e11 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.115.1 +version: 0.116.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 c41ce80a47b..ee0018bb0dd 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.115.1 +version: 0.116.0 core: | Set the current cursor position. usage: | diff --git a/commands/docs/commandline_set-prompt.md b/commands/docs/commandline_set-prompt.md index f7189b65065..70eb7fe3fbe 100644 --- a/commands/docs/commandline_set-prompt.md +++ b/commands/docs/commandline_set-prompt.md @@ -2,7 +2,7 @@ title: commandline set-prompt categories: | core -version: 0.115.1 +version: 0.116.0 core: | Replace the current prompt and repaint it in place, without disturbing the line being edited. usage: | diff --git a/commands/docs/compact.md b/commands/docs/compact.md index 9821cb2a996..9cc68798c24 100644 --- a/commands/docs/compact.md +++ b/commands/docs/compact.md @@ -2,7 +2,7 @@ title: compact categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Creates a table with non-empty rows. usage: | diff --git a/commands/docs/complete.md b/commands/docs/complete.md index 20a0977b31f..1c9ab882062 100644 --- a/commands/docs/complete.md +++ b/commands/docs/complete.md @@ -2,7 +2,7 @@ title: complete categories: | system -version: 0.115.1 +version: 0.116.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 51451d05925..1beb1b6bec4 100644 --- a/commands/docs/config.md +++ b/commands/docs/config.md @@ -2,7 +2,7 @@ title: config categories: | env -version: 0.115.1 +version: 0.116.0 env: | Edit nushell configuration files. usage: | diff --git a/commands/docs/config_env.md b/commands/docs/config_env.md index 803be68f2d9..a49b0e7a9ab 100644 --- a/commands/docs/config_env.md +++ b/commands/docs/config_env.md @@ -2,7 +2,7 @@ title: config env categories: | env -version: 0.115.1 +version: 0.116.0 env: | Edit nu environment configurations. usage: | diff --git a/commands/docs/config_flatten.md b/commands/docs/config_flatten.md index 386df888701..4ac3c8eb8b9 100644 --- a/commands/docs/config_flatten.md +++ b/commands/docs/config_flatten.md @@ -2,7 +2,7 @@ title: config flatten categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Show the current configuration in a flattened form. usage: | diff --git a/commands/docs/config_nu.md b/commands/docs/config_nu.md index ccacbc7e176..a91ff585621 100644 --- a/commands/docs/config_nu.md +++ b/commands/docs/config_nu.md @@ -2,7 +2,7 @@ title: config nu categories: | env -version: 0.115.1 +version: 0.116.0 env: | Edit nu configurations. usage: | diff --git a/commands/docs/config_reset.md b/commands/docs/config_reset.md index 9c656a2db3e..e59052ffe6a 100644 --- a/commands/docs/config_reset.md +++ b/commands/docs/config_reset.md @@ -2,7 +2,7 @@ title: config reset categories: | env -version: 0.115.1 +version: 0.116.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/config_use-colors.md b/commands/docs/config_use-colors.md index 8b8ecd4ccaf..0e40ed56289 100644 --- a/commands/docs/config_use-colors.md +++ b/commands/docs/config_use-colors.md @@ -2,7 +2,7 @@ title: config use-colors categories: | env -version: 0.115.1 +version: 0.116.0 env: | Get the configuration for color output. usage: | diff --git a/commands/docs/const.md b/commands/docs/const.md index d8c15082331..82e5dedb2f1 100644 --- a/commands/docs/const.md +++ b/commands/docs/const.md @@ -2,7 +2,7 @@ title: const categories: | core -version: 0.115.1 +version: 0.116.0 core: | Create a parse-time constant. usage: | diff --git a/commands/docs/continue.md b/commands/docs/continue.md index c194d862bfb..54ecd9ddee6 100644 --- a/commands/docs/continue.md +++ b/commands/docs/continue.md @@ -2,7 +2,7 @@ title: continue categories: | core -version: 0.115.1 +version: 0.116.0 core: | Continue a loop from the next iteration. usage: | diff --git a/commands/docs/cp.md b/commands/docs/cp.md index 82e8a7aac5d..87c5a341ff6 100644 --- a/commands/docs/cp.md +++ b/commands/docs/cp.md @@ -2,7 +2,7 @@ title: cp categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Copy files using uutils/coreutils cp. usage: | diff --git a/commands/docs/date.md b/commands/docs/date.md index 203bb435c1c..1175dffb686 100644 --- a/commands/docs/date.md +++ b/commands/docs/date.md @@ -2,7 +2,7 @@ title: date categories: | date -version: 0.115.1 +version: 0.116.0 date: | Date-related commands. usage: | @@ -40,6 +40,6 @@ You must use one of the following subcommands. Using this command as-is will onl | [`date format`](/commands/docs/date_format.md) | Removed command: use `format date` instead. | built-in | | [`date from-human`](/commands/docs/date_from-human.md) | Convert a human readable datetime string to a datetime. | built-in | | [`date humanize`](/commands/docs/date_humanize.md) | Print a 'humanized' format for the date, relative to now. | built-in | -| [`date list-timezone`](/commands/docs/date_list-timezone.md) | List supported time zones. | built-in | +| [`date list-timezone`](/commands/docs/date_list-timezone.md) | List supported time zones and their current offsets. | built-in | | [`date now`](/commands/docs/date_now.md) | Get the current date. | built-in | | [`date to-timezone`](/commands/docs/date_to-timezone.md) | Convert a date to a given time zone. | built-in | \ No newline at end of file diff --git a/commands/docs/date_format.md b/commands/docs/date_format.md index 3aaf8b2abaf..fa78c76036b 100644 --- a/commands/docs/date_format.md +++ b/commands/docs/date_format.md @@ -2,7 +2,7 @@ title: date format categories: | removed -version: 0.115.1 +version: 0.116.0 removed: | Removed command: use `format date` instead. usage: | diff --git a/commands/docs/date_from-human.md b/commands/docs/date_from-human.md index 96fd53ef96e..ec5a0346110 100644 --- a/commands/docs/date_from-human.md +++ b/commands/docs/date_from-human.md @@ -2,7 +2,7 @@ title: date from-human categories: | date -version: 0.115.1 +version: 0.116.0 date: | Convert a human readable datetime string to a datetime. usage: | diff --git a/commands/docs/date_humanize.md b/commands/docs/date_humanize.md index 4c75ea6d841..e75783f9d5b 100644 --- a/commands/docs/date_humanize.md +++ b/commands/docs/date_humanize.md @@ -2,7 +2,7 @@ title: date humanize categories: | date -version: 0.115.1 +version: 0.116.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 75127773be7..1573928c9ec 100644 --- a/commands/docs/date_list-timezone.md +++ b/commands/docs/date_list-timezone.md @@ -2,11 +2,11 @@ title: date list-timezone categories: | date -version: 0.115.1 +version: 0.116.0 date: | - List supported time zones. + List supported time zones and their current offsets. usage: | - List supported time zones. + List supported time zones and their current offsets. editLink: false contributors: false --- @@ -14,7 +14,7 @@ contributors: false # `date list-timezone` for [date](/commands/categories/date.md) -
List supported time zones.
+
List supported time zones and their current offsets.
## Command Type @@ -27,18 +27,18 @@ contributors: false ## Input/output types: -| input | output | -| ------- | ------ | -| nothing | table | +| input | output | +| ------- | --------------------------------------- | +| nothing | table<timezone: string, offset: string> | ## Examples Show time zone(s) that contains 'Shanghai'. ```nu > date list-timezone | where timezone =~ Shanghai -╭───┬───────────────╮ -│ # │ timezone │ -├───┼───────────────┤ -│ 0 │ Asia/Shanghai │ -╰───┴───────────────╯ +╭───┬───────────────┬────────╮ +│ # │ timezone │ offset │ +├───┼───────────────┼────────┤ +│ 0 │ Asia/Shanghai │ +08:00 │ +╰───┴───────────────┴────────╯ ``` diff --git a/commands/docs/date_now.md b/commands/docs/date_now.md index dcf3133209b..209d3fcdc0b 100644 --- a/commands/docs/date_now.md +++ b/commands/docs/date_now.md @@ -2,7 +2,7 @@ title: date now categories: | date -version: 0.115.1 +version: 0.116.0 date: | Get the current date. usage: | diff --git a/commands/docs/date_to-timezone.md b/commands/docs/date_to-timezone.md index d9c04306b7b..809755b0133 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.115.1 +version: 0.116.0 date: | Convert a date to a given time zone. usage: | diff --git a/commands/docs/debug.md b/commands/docs/debug.md index b487a77ef2a..60a8e63f19a 100644 --- a/commands/docs/debug.md +++ b/commands/docs/debug.md @@ -2,7 +2,7 @@ title: debug categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Debug print the value(s) piped in. usage: | diff --git a/commands/docs/debug_env.md b/commands/docs/debug_env.md index 925909e0697..7383e4c4479 100644 --- a/commands/docs/debug_env.md +++ b/commands/docs/debug_env.md @@ -2,7 +2,7 @@ title: debug env categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Show environment variables as external commands would get it. usage: | diff --git a/commands/docs/debug_experimental-options.md b/commands/docs/debug_experimental-options.md index 705eb822069..b8e792c26b0 100644 --- a/commands/docs/debug_experimental-options.md +++ b/commands/docs/debug_experimental-options.md @@ -2,7 +2,7 @@ title: debug experimental-options categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Show all experimental options. usage: | diff --git a/commands/docs/debug_info.md b/commands/docs/debug_info.md index 058b454abde..e2f444e0759 100644 --- a/commands/docs/debug_info.md +++ b/commands/docs/debug_info.md @@ -2,7 +2,7 @@ title: debug info categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | View process memory info. usage: | diff --git a/commands/docs/debug_profile.md b/commands/docs/debug_profile.md index 2df775b2560..620bff2e650 100644 --- a/commands/docs/debug_profile.md +++ b/commands/docs/debug_profile.md @@ -2,7 +2,7 @@ title: debug profile categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Profile pipeline elements in a closure. usage: | diff --git a/commands/docs/decode.md b/commands/docs/decode.md index d005df87fff..53046affba1 100644 --- a/commands/docs/decode.md +++ b/commands/docs/decode.md @@ -2,7 +2,7 @@ title: decode categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Decode bytes into a string. usage: | diff --git a/commands/docs/decode_base32.md b/commands/docs/decode_base32.md index 80c000628cf..b099d33421d 100644 --- a/commands/docs/decode_base32.md +++ b/commands/docs/decode_base32.md @@ -2,7 +2,7 @@ title: decode base32 categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Decode a Base32-encoded value. usage: | diff --git a/commands/docs/decode_base32hex.md b/commands/docs/decode_base32hex.md index 4f58c885787..c26a9868805 100644 --- a/commands/docs/decode_base32hex.md +++ b/commands/docs/decode_base32hex.md @@ -2,7 +2,7 @@ title: decode base32hex categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Encode a base32hex value. usage: | diff --git a/commands/docs/decode_base64.md b/commands/docs/decode_base64.md index a26fd1d475f..553b889fd19 100644 --- a/commands/docs/decode_base64.md +++ b/commands/docs/decode_base64.md @@ -2,7 +2,7 @@ title: decode base64 categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Decode a Base64-encoded value. usage: | diff --git a/commands/docs/decode_hex.md b/commands/docs/decode_hex.md index ad5993c77c8..f71d4e0b865 100644 --- a/commands/docs/decode_hex.md +++ b/commands/docs/decode_hex.md @@ -2,7 +2,7 @@ title: decode hex categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Decode a hex-encoded value. usage: | diff --git a/commands/docs/def.md b/commands/docs/def.md index c424a95151b..c16cbe357e4 100644 --- a/commands/docs/def.md +++ b/commands/docs/def.md @@ -2,7 +2,7 @@ title: def categories: | core -version: 0.115.1 +version: 0.116.0 core: | Define a custom command. usage: | diff --git a/commands/docs/default.md b/commands/docs/default.md index 66b3d70809b..1d169e0969c 100644 --- a/commands/docs/default.md +++ b/commands/docs/default.md @@ -2,7 +2,7 @@ title: default categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Sets a default value if a row's column is missing or null. usage: | @@ -31,7 +31,7 @@ contributors: false ## Parameters - `default value`: The value to use as a default. - - `...rest`: The name of the column. + - `...rest`: The name (or cell path) of the column. ## Input/output types: @@ -89,6 +89,17 @@ Replace the empty string in the "a" column of a list ``` +Fill a missing nested value using a cell path +```nu +> {a: {b: 1}} | default 2 a.c +╭───┬───────────╮ +│ │ ╭───┬───╮ │ +│ a │ │ b │ 1 │ │ +│ │ │ c │ 2 │ │ +│ │ ╰───┴───╯ │ +╰───┴───────────╯ +``` + Generate a default value from a closure ```nu > null | default { 1 + 2 } diff --git a/commands/docs/describe.md b/commands/docs/describe.md index a7fab28a7da..0976afb0d03 100644 --- a/commands/docs/describe.md +++ b/commands/docs/describe.md @@ -2,7 +2,7 @@ title: describe categories: | core -version: 0.115.1 +version: 0.116.0 core: | Describe the type and structure of the value(s) piped in. usage: | diff --git a/commands/docs/detect.md b/commands/docs/detect.md index dac5ebb4672..59aba0e55d0 100644 --- a/commands/docs/detect.md +++ b/commands/docs/detect.md @@ -2,7 +2,7 @@ title: detect categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Various commands for detecting things. usage: | diff --git a/commands/docs/detect_columns.md b/commands/docs/detect_columns.md index d86be32ad75..7ad7aec0cd2 100644 --- a/commands/docs/detect_columns.md +++ b/commands/docs/detect_columns.md @@ -2,7 +2,7 @@ title: detect columns categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Attempt to automatically split text into multiple columns. usage: | diff --git a/commands/docs/detect_type.md b/commands/docs/detect_type.md index 305d526484e..a0dd09f7573 100644 --- a/commands/docs/detect_type.md +++ b/commands/docs/detect_type.md @@ -2,7 +2,7 @@ title: detect type categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Infer Nushell datatype from a string. usage: | diff --git a/commands/docs/difference.md b/commands/docs/difference.md index 33a4bbafa79..8381e845123 100644 --- a/commands/docs/difference.md +++ b/commands/docs/difference.md @@ -2,7 +2,7 @@ title: difference categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Returns a list of unique elements in the input that are not present in the other list. usage: | diff --git a/commands/docs/do.md b/commands/docs/do.md index b20fb45bc00..cde1be6db4b 100644 --- a/commands/docs/do.md +++ b/commands/docs/do.md @@ -2,7 +2,7 @@ title: do categories: | core -version: 0.115.1 +version: 0.116.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 53c57d6f664..6613b5558ba 100644 --- a/commands/docs/drop.md +++ b/commands/docs/drop.md @@ -2,7 +2,7 @@ title: drop categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Remove items/rows from the end of the input list/table, or remove bytes from the end of binary data. Counterpart of `skip`. Opposite of `last`. For binary input, `rows` can also be specified as a filesize. usage: | diff --git a/commands/docs/drop_column.md b/commands/docs/drop_column.md index 089f6a5d919..2aebecc102c 100644 --- a/commands/docs/drop_column.md +++ b/commands/docs/drop_column.md @@ -2,7 +2,7 @@ title: drop column categories: | filters -version: 0.115.1 +version: 0.116.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 529909d0956..dd84203344a 100644 --- a/commands/docs/drop_nth.md +++ b/commands/docs/drop_nth.md @@ -2,7 +2,7 @@ title: drop nth categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Drop the selected rows. usage: | diff --git a/commands/docs/du.md b/commands/docs/du.md index 7fb78642131..6a311386ddf 100644 --- a/commands/docs/du.md +++ b/commands/docs/du.md @@ -2,7 +2,7 @@ title: du categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Find disk usage sizes of specified items. usage: | diff --git a/commands/docs/each.md b/commands/docs/each.md index 0f533e8b8f3..1b4ddd1502d 100644 --- a/commands/docs/each.md +++ b/commands/docs/each.md @@ -2,7 +2,7 @@ title: each categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Run a closure on each row of the input list, creating a new list with the results. usage: | @@ -95,7 +95,7 @@ Iterate over each element, keeping null results. ``` -Update value if not null, otherwise do nothing. +Return "hello $name" for each name in the list of names $env.name, or return "bye" if $env.name does not exist. ```nu > $env.name? | each { $"hello ($in)" } | default "bye" @@ -107,27 +107,39 @@ Scan through multiple files without pause. ``` -## Notes -Since tables are lists of records, passing a table into 'each' will -iterate over each record, not necessarily each cell within it. +Print chunks of data from an external command as soon as they become available. +```nu +> ^$nu.current-exe -c 'print hello; sleep 0.5sec; print world' | each { print $in } | ignore + +``` -Avoid passing single records to this command. Since a record is a -one-row structure, 'each' will only run once, behaving similar to 'do'. -To iterate over a record's values, use 'items' or try converting it to a table -with 'transpose' first. +## Notes +Since tables are lists of records, passing a table into 'each' will iterate over each +record, not necessarily each cell within it. +Avoid passing single records to this command. Since a record is a one-row structure, +'each' will only run once, behaving similar to 'do'. To iterate over a record's values, +use 'items' or try converting it to a table with 'transpose' first. -By default, for each input there is a single output value. -If the closure returns a stream rather than value, the stream is collected -completely, and the resulting value becomes one of the items in `each`'s output. +By default, for each input there is a single output value. If the closure returns a +stream rather than value, the stream is collected completely, and the resulting value +becomes one of the items in `each`'s output. To receive items from those streams without waiting for the whole stream to be -collected, `each --flatten` can be used. -Instead of waiting for the stream to be collected before returning the result as -a single item, `each --flatten` will return each item as soon as they are received. - -This "flattens" the output, turning an output that would otherwise be a -list of lists like `list>` into a flat list like `list`. +collected, `each --flatten` can be used. Instead of waiting for the stream to be +collected before returning the result as a single item, `each --flatten` will return +each item as soon as they are received. + +This "flattens" the output, turning an output that would otherwise be a list of lists +like `list>` into a flat list like `list`. + +String or byte streams, empty pipelines, null values, ranges, and some custom values +can also be used as inputs to 'each'. A stream of bytes or strings (usually from +external commands) will be treated as though it was a list of chunks of the stream, +where the size of the chunks are determined arbitrarily. Empty pipelines and null +values are both returned unchanged from 'each' without calling the provided closure. +Ranges and custom values which can be iterated will be treated as lists of the values +they represent. ## Subcommands: diff --git a/commands/docs/each_while.md b/commands/docs/each_while.md index 2e57a7bb025..118238af95c 100644 --- a/commands/docs/each_while.md +++ b/commands/docs/each_while.md @@ -2,7 +2,7 @@ title: each while categories: | filters -version: 0.115.1 +version: 0.116.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 454dfaf7408..bb1c61c5361 100644 --- a/commands/docs/echo.md +++ b/commands/docs/echo.md @@ -2,7 +2,7 @@ title: echo categories: | core -version: 0.115.1 +version: 0.116.0 core: | Returns its arguments, ignoring the piped-in value. usage: | diff --git a/commands/docs/encode.md b/commands/docs/encode.md index 79e7775cc69..eea2825d55d 100644 --- a/commands/docs/encode.md +++ b/commands/docs/encode.md @@ -2,7 +2,7 @@ title: encode categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Encode a string into bytes. usage: | diff --git a/commands/docs/encode_base32.md b/commands/docs/encode_base32.md index 8b20ff52c9f..da2628a5cd3 100644 --- a/commands/docs/encode_base32.md +++ b/commands/docs/encode_base32.md @@ -2,7 +2,7 @@ title: encode base32 categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Encode a string or binary value using Base32. usage: | diff --git a/commands/docs/encode_base32hex.md b/commands/docs/encode_base32hex.md index ae577e710ce..fb2645cfdd2 100644 --- a/commands/docs/encode_base32hex.md +++ b/commands/docs/encode_base32hex.md @@ -2,7 +2,7 @@ title: encode base32hex categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Encode a binary value or a string using base32hex. usage: | diff --git a/commands/docs/encode_base64.md b/commands/docs/encode_base64.md index 50e22f52534..bd3745a525b 100644 --- a/commands/docs/encode_base64.md +++ b/commands/docs/encode_base64.md @@ -2,7 +2,7 @@ title: encode base64 categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Encode a string or binary value using Base64. usage: | diff --git a/commands/docs/encode_hex.md b/commands/docs/encode_hex.md index 7d77a674851..58d46f15b40 100644 --- a/commands/docs/encode_hex.md +++ b/commands/docs/encode_hex.md @@ -2,7 +2,7 @@ title: encode hex categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Hex encode a binary value or a string. usage: | diff --git a/commands/docs/enumerate.md b/commands/docs/enumerate.md index 0ca73b4db23..c6e9b703107 100644 --- a/commands/docs/enumerate.md +++ b/commands/docs/enumerate.md @@ -2,7 +2,7 @@ title: enumerate categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Enumerate the elements in a stream. usage: | diff --git a/commands/docs/error.md b/commands/docs/error.md index 8a07bba0fba..ad2f9d05a42 100644 --- a/commands/docs/error.md +++ b/commands/docs/error.md @@ -2,7 +2,7 @@ title: error categories: | core -version: 0.115.1 +version: 0.116.0 core: | Various commands for working with errors. usage: | diff --git a/commands/docs/error_make.md b/commands/docs/error_make.md index 51e89130296..b19d85fb847 100644 --- a/commands/docs/error_make.md +++ b/commands/docs/error_make.md @@ -2,7 +2,7 @@ title: error make categories: | core -version: 0.115.1 +version: 0.116.0 core: | Create an error. usage: | diff --git a/commands/docs/every.md b/commands/docs/every.md index 0f545f8a43c..57ed5ae2199 100644 --- a/commands/docs/every.md +++ b/commands/docs/every.md @@ -2,7 +2,7 @@ title: every categories: | filters -version: 0.115.1 +version: 0.116.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 970a9b20822..4d4aae7f612 100644 --- a/commands/docs/exec.md +++ b/commands/docs/exec.md @@ -2,7 +2,7 @@ title: exec categories: | system -version: 0.115.1 +version: 0.116.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 cf75d1a2143..ae21d0682cc 100644 --- a/commands/docs/exit.md +++ b/commands/docs/exit.md @@ -2,7 +2,7 @@ title: exit categories: | shells -version: 0.115.1 +version: 0.116.0 shells: | Exit Nu. usage: | diff --git a/commands/docs/explain.md b/commands/docs/explain.md index c882efb2d1c..d7c43ab4db9 100644 --- a/commands/docs/explain.md +++ b/commands/docs/explain.md @@ -2,7 +2,7 @@ title: explain categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Explain closure contents. usage: | diff --git a/commands/docs/explore.md b/commands/docs/explore.md index acd32044d08..85d1a77fac3 100644 --- a/commands/docs/explore.md +++ b/commands/docs/explore.md @@ -2,7 +2,7 @@ title: explore categories: | viewers -version: 0.115.1 +version: 0.116.0 viewers: | Explore acts as a table pager, just like `less` does for text. usage: | diff --git a/commands/docs/explore_config.md b/commands/docs/explore_config.md index a93d542c66e..a950b21a2d0 100644 --- a/commands/docs/explore_config.md +++ b/commands/docs/explore_config.md @@ -2,7 +2,7 @@ title: explore config categories: | viewers -version: 0.115.1 +version: 0.116.0 viewers: | Launch a TUI to view and edit the nushell configuration interactively. usage: | diff --git a/commands/docs/explore_regex.md b/commands/docs/explore_regex.md index 4b8c1d590e1..4c42ec7ac26 100644 --- a/commands/docs/explore_regex.md +++ b/commands/docs/explore_regex.md @@ -2,7 +2,7 @@ title: explore regex categories: | viewers -version: 0.115.1 +version: 0.116.0 viewers: | Launch a TUI to create and explore regular expressions interactively. usage: | diff --git a/commands/docs/export-env.md b/commands/docs/export-env.md index 7873c79d55b..9b85cf30a7b 100644 --- a/commands/docs/export-env.md +++ b/commands/docs/export-env.md @@ -2,7 +2,7 @@ title: export-env categories: | env -version: 0.115.1 +version: 0.116.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 a4d15066d41..31c969b35b8 100644 --- a/commands/docs/export.md +++ b/commands/docs/export.md @@ -2,7 +2,7 @@ title: export categories: | core -version: 0.115.1 +version: 0.116.0 core: | Export definitions or environment variables from a module. usage: | diff --git a/commands/docs/export_alias.md b/commands/docs/export_alias.md index 73a37c81b38..6f2c23f9b51 100644 --- a/commands/docs/export_alias.md +++ b/commands/docs/export_alias.md @@ -2,7 +2,7 @@ title: export alias categories: | core -version: 0.115.1 +version: 0.116.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 31f52a027be..ac0c10cfa0e 100644 --- a/commands/docs/export_const.md +++ b/commands/docs/export_const.md @@ -2,7 +2,7 @@ title: export const categories: | core -version: 0.115.1 +version: 0.116.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 a8dad394fc3..331c124a24f 100644 --- a/commands/docs/export_def.md +++ b/commands/docs/export_def.md @@ -2,7 +2,7 @@ title: export def categories: | core -version: 0.115.1 +version: 0.116.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 cb699363b0e..9eff6071b7f 100644 --- a/commands/docs/export_extern.md +++ b/commands/docs/export_extern.md @@ -2,7 +2,7 @@ title: export extern categories: | core -version: 0.115.1 +version: 0.116.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 31ca822dafa..a614f7ec94c 100644 --- a/commands/docs/export_module.md +++ b/commands/docs/export_module.md @@ -2,7 +2,7 @@ title: export module categories: | core -version: 0.115.1 +version: 0.116.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 b3293fca7a9..22c988c2603 100644 --- a/commands/docs/export_use.md +++ b/commands/docs/export_use.md @@ -2,7 +2,7 @@ title: export use categories: | core -version: 0.115.1 +version: 0.116.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 ab9df7a53d7..91be4ece788 100644 --- a/commands/docs/extern.md +++ b/commands/docs/extern.md @@ -2,7 +2,7 @@ title: extern categories: | core -version: 0.115.1 +version: 0.116.0 core: | Define a signature for an external command. usage: | diff --git a/commands/docs/fill.md b/commands/docs/fill.md index ced6a1639cf..aed512692a0 100644 --- a/commands/docs/fill.md +++ b/commands/docs/fill.md @@ -2,7 +2,7 @@ title: fill categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Fill and align text in columns. usage: | diff --git a/commands/docs/filter.md b/commands/docs/filter.md index 1f1cf529aa6..aba592b4f94 100644 --- a/commands/docs/filter.md +++ b/commands/docs/filter.md @@ -2,7 +2,7 @@ title: filter categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Filter values based on a predicate closure. usage: | diff --git a/commands/docs/find.md b/commands/docs/find.md index c369dfaaeff..fc32bcf4b53 100644 --- a/commands/docs/find.md +++ b/commands/docs/find.md @@ -2,7 +2,7 @@ title: find categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Search for terms in the input data. usage: | diff --git a/commands/docs/first.md b/commands/docs/first.md index 5aa80a9947d..7b3fc793ef6 100644 --- a/commands/docs/first.md +++ b/commands/docs/first.md @@ -2,7 +2,7 @@ title: first categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Return only the first several rows of the input. Counterpart of `last`. Opposite of `skip`. For binary input, rows can also be specified as a filesize. usage: | diff --git a/commands/docs/flatten.md b/commands/docs/flatten.md index 6db83a57fd3..1173a5b04f6 100644 --- a/commands/docs/flatten.md +++ b/commands/docs/flatten.md @@ -2,7 +2,7 @@ title: flatten categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Flatten a table by extracting nested values. usage: | @@ -74,6 +74,17 @@ restrict the flattening by passing column names. ``` +Flatten a record: nested record fields are lifted, and a lifted field that collides with a top-level column is prefixed with its parent key. +```nu +> { a: { b: 1, c: 2 }, c: 3 } | flatten +╭───┬───┬─────┬───╮ +│ # │ b │ a_c │ c │ +├───┼───┼─────┼───┤ +│ 0 │ 1 │ 2 │ 3 │ +╰───┴───┴─────┴───╯ + +``` + Flatten inner table. ```nu > { a: b, d: [ 1 2 3 4 ], e: [ 4 3 ] } | flatten d --all @@ -99,3 +110,9 @@ Flatten inner table. ╰───┴───┴───┴───────────╯ ``` + +## Notes +A record is treated as a one-row table, so the output is always a table. +Fields of a nested record are lifted to the top level and the parent key is dropped. +If a lifted field would collide with a top-level column, it is renamed to `_`. +A nested list is expanded into one row per element. \ No newline at end of file diff --git a/commands/docs/for.md b/commands/docs/for.md index 54e16359b5c..85794e7ab14 100644 --- a/commands/docs/for.md +++ b/commands/docs/for.md @@ -2,7 +2,7 @@ title: for categories: | core -version: 0.115.1 +version: 0.116.0 core: | Loop over a range. usage: | diff --git a/commands/docs/format.md b/commands/docs/format.md index feb24876865..5cebcd3388d 100644 --- a/commands/docs/format.md +++ b/commands/docs/format.md @@ -2,7 +2,7 @@ title: format categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Various commands for formatting data. usage: | diff --git a/commands/docs/format_bits.md b/commands/docs/format_bits.md index 32ca672145b..bdfd8d1f7d7 100644 --- a/commands/docs/format_bits.md +++ b/commands/docs/format_bits.md @@ -2,7 +2,7 @@ title: format bits categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a string of binary data represented by 0 and 1. usage: | diff --git a/commands/docs/format_date.md b/commands/docs/format_date.md index 7311568d6d2..37dafe7d251 100644 --- a/commands/docs/format_date.md +++ b/commands/docs/format_date.md @@ -2,7 +2,7 @@ title: format date categories: | strings -version: 0.115.1 +version: 0.116.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 4a946b12e86..74cc5e6cc94 100644 --- a/commands/docs/format_duration.md +++ b/commands/docs/format_duration.md @@ -2,7 +2,7 @@ title: format duration categories: | strings -version: 0.115.1 +version: 0.116.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 fd9eb97c8af..316f1bd5d61 100644 --- a/commands/docs/format_filesize.md +++ b/commands/docs/format_filesize.md @@ -2,7 +2,7 @@ title: format filesize categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Converts a column of filesizes to some specified format. usage: | diff --git a/commands/docs/format_number.md b/commands/docs/format_number.md index 5da391b7ab0..91cd543b147 100644 --- a/commands/docs/format_number.md +++ b/commands/docs/format_number.md @@ -2,7 +2,7 @@ title: format number categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Format a number. usage: | diff --git a/commands/docs/format_pattern.md b/commands/docs/format_pattern.md index 49d16adae19..4b0015c2df9 100644 --- a/commands/docs/format_pattern.md +++ b/commands/docs/format_pattern.md @@ -2,7 +2,7 @@ title: format pattern categories: | strings -version: 0.115.1 +version: 0.116.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 ba4d7147954..802d796e765 100644 --- a/commands/docs/from.md +++ b/commands/docs/from.md @@ -2,7 +2,7 @@ title: from categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Parse a string or binary data into structured data. usage: | diff --git a/commands/docs/from_csv.md b/commands/docs/from_csv.md index a7e1f9481c2..044aaf37a09 100644 --- a/commands/docs/from_csv.md +++ b/commands/docs/from_csv.md @@ -2,7 +2,7 @@ title: from csv categories: | formats -version: 0.115.1 +version: 0.116.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 74ec9b304d7..df387b35f4b 100644 --- a/commands/docs/from_eml.md +++ b/commands/docs/from_eml.md @@ -2,7 +2,7 @@ title: from eml categories: | formats -version: 0.115.1 +version: 0.116.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 085c0e48fdd..66644944996 100644 --- a/commands/docs/from_ics.md +++ b/commands/docs/from_ics.md @@ -2,7 +2,7 @@ title: from ics categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Parse text as .ics and create table. usage: | @@ -43,15 +43,11 @@ Converts ics formatted string to table ```nu > 'BEGIN:VCALENDAR END:VCALENDAR' | from ics -╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────┬──────╮ -│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ time │ -│ │ │ │ │ │ │ │ zone │ -│ │ │ │ │ │ │ │ s │ -├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────┼──────┤ -│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 │ [lis │ -│ │ │ │ │ │ │ items] │ t 0 │ -│ │ │ │ │ │ │ │ item │ -│ │ │ │ │ │ │ │ s] │ -╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────┴──────╯ +╭───┬────────────────┬────────────────┬────────────────┬────────────────┬────────────────┬────────────┬─────╮ +│ # │ properties │ events │ alarms │ to-Dos │ journals │ free-busys │ ... │ +├───┼────────────────┼────────────────┼────────────────┼────────────────┼────────────────┼────────────┼─────┤ +│ 0 │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 items] │ [list 0 │ ... │ +│ │ │ │ │ │ │ items] │ │ +╰───┴────────────────┴────────────────┴────────────────┴────────────────┴────────────────┴────────────┴─────╯ ``` diff --git a/commands/docs/from_ini.md b/commands/docs/from_ini.md index 693e9217f9a..f8c79749573 100644 --- a/commands/docs/from_ini.md +++ b/commands/docs/from_ini.md @@ -2,7 +2,7 @@ title: from ini categories: | formats -version: 0.115.1 +version: 0.116.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 74193c82d94..908b999c34f 100644 --- a/commands/docs/from_json.md +++ b/commands/docs/from_json.md @@ -2,7 +2,7 @@ title: from json categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert JSON text into structured data. usage: | diff --git a/commands/docs/from_kdl.md b/commands/docs/from_kdl.md index cfe4051177c..f48c6bcd79c 100644 --- a/commands/docs/from_kdl.md +++ b/commands/docs/from_kdl.md @@ -2,7 +2,7 @@ title: from kdl categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert KDL text into structured data. usage: | @@ -58,72 +58,23 @@ Convert KDL to node rows (default format, KDL v2). Parse a package-style KDL document into node rows. ```nu > 'package { name nu; version 0.1; description "new type of shell" }' | from kdl -╭───┬─────────┬────────────────┬───────────────────┬─────────────────────────────────────────────────────────╮ -│ # │ name │ args │ props │ children │ -├───┼─────────┼────────────────┼───────────────────┼─────────────────────────────────────────────────────────┤ -│ 0 │ package │ [list 0 items] │ {record 0 fields} │ ╭───┬─────────────┬───────────────────────────┬───┬───╮ │ -│ │ │ │ │ │ # │ name │ args │ p │ c │ │ -│ │ │ │ │ │ │ │ │ r │ h │ │ -│ │ │ │ │ │ │ │ │ o │ i │ │ -│ │ │ │ │ │ │ │ │ p │ l │ │ -│ │ │ │ │ │ │ │ │ s │ d │ │ -│ │ │ │ │ │ │ │ │ │ r │ │ -│ │ │ │ │ │ │ │ │ │ e │ │ -│ │ │ │ │ │ │ │ │ │ n │ │ -│ │ │ │ │ ├───┼─────────────┼───────────────────────────┼───┼───┤ │ -│ │ │ │ │ │ 0 │ name │ ╭───┬────╮ │ { │ [ │ │ -│ │ │ │ │ │ │ │ │ 0 │ nu │ │ r │ l │ │ -│ │ │ │ │ │ │ │ ╰───┴────╯ │ e │ i │ │ -│ │ │ │ │ │ │ │ │ c │ s │ │ -│ │ │ │ │ │ │ │ │ o │ t │ │ -│ │ │ │ │ │ │ │ │ r │ │ │ -│ │ │ │ │ │ │ │ │ d │ 0 │ │ -│ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ 0 │ i │ │ -│ │ │ │ │ │ │ │ │ │ t │ │ -│ │ │ │ │ │ │ │ │ f │ e │ │ -│ │ │ │ │ │ │ │ │ i │ m │ │ -│ │ │ │ │ │ │ │ │ e │ s │ │ -│ │ │ │ │ │ │ │ │ l │ ] │ │ -│ │ │ │ │ │ │ │ │ d │ │ │ -│ │ │ │ │ │ │ │ │ s │ │ │ -│ │ │ │ │ │ │ │ │ } │ │ │ -│ │ │ │ │ │ 1 │ version │ ╭───┬──────╮ │ { │ [ │ │ -│ │ │ │ │ │ │ │ │ 0 │ 0.10 │ │ r │ l │ │ -│ │ │ │ │ │ │ │ ╰───┴──────╯ │ e │ i │ │ -│ │ │ │ │ │ │ │ │ c │ s │ │ -│ │ │ │ │ │ │ │ │ o │ t │ │ -│ │ │ │ │ │ │ │ │ r │ │ │ -│ │ │ │ │ │ │ │ │ d │ 0 │ │ -│ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ 0 │ i │ │ -│ │ │ │ │ │ │ │ │ │ t │ │ -│ │ │ │ │ │ │ │ │ f │ e │ │ -│ │ │ │ │ │ │ │ │ i │ m │ │ -│ │ │ │ │ │ │ │ │ e │ s │ │ -│ │ │ │ │ │ │ │ │ l │ ] │ │ -│ │ │ │ │ │ │ │ │ d │ │ │ -│ │ │ │ │ │ │ │ │ s │ │ │ -│ │ │ │ │ │ │ │ │ } │ │ │ -│ │ │ │ │ │ 2 │ description │ ╭───┬───────────────────╮ │ { │ [ │ │ -│ │ │ │ │ │ │ │ │ 0 │ new type of shell │ │ r │ l │ │ -│ │ │ │ │ │ │ │ ╰───┴───────────────────╯ │ e │ i │ │ -│ │ │ │ │ │ │ │ │ c │ s │ │ -│ │ │ │ │ │ │ │ │ o │ t │ │ -│ │ │ │ │ │ │ │ │ r │ │ │ -│ │ │ │ │ │ │ │ │ d │ 0 │ │ -│ │ │ │ │ │ │ │ │ │ │ │ -│ │ │ │ │ │ │ │ │ 0 │ i │ │ -│ │ │ │ │ │ │ │ │ │ t │ │ -│ │ │ │ │ │ │ │ │ f │ e │ │ -│ │ │ │ │ │ │ │ │ i │ m │ │ -│ │ │ │ │ │ │ │ │ e │ s │ │ -│ │ │ │ │ │ │ │ │ l │ ] │ │ -│ │ │ │ │ │ │ │ │ d │ │ │ -│ │ │ │ │ │ │ │ │ s │ │ │ -│ │ │ │ │ │ │ │ │ } │ │ │ -│ │ │ │ │ ╰───┴─────────────┴───────────────────────────┴───┴───╯ │ -╰───┴─────────┴────────────────┴───────────────────┴─────────────────────────────────────────────────────────╯ +╭────┬──────────┬────────────────┬───────────────────┬───────────────────────────────────────────────────────╮ +│ # │ name │ args │ props │ children │ +├────┼──────────┼────────────────┼───────────────────┼───────────────────────────────────────────────────────┤ +│ 0 │ package │ [list 0 items] │ {record 0 fields} │ ╭───┬─────────────┬───────────────────────────┬─────╮ │ +│ │ │ │ │ │ # │ name │ args │ ... │ │ +│ │ │ │ │ ├───┼─────────────┼───────────────────────────┼─────┤ │ +│ │ │ │ │ │ 0 │ name │ ╭───┬────╮ │ ... │ │ +│ │ │ │ │ │ │ │ │ 0 │ nu │ │ │ │ +│ │ │ │ │ │ │ │ ╰───┴────╯ │ │ │ +│ │ │ │ │ │ 1 │ version │ ╭───┬──────╮ │ ... │ │ +│ │ │ │ │ │ │ │ │ 0 │ 0.10 │ │ │ │ +│ │ │ │ │ │ │ │ ╰───┴──────╯ │ │ │ +│ │ │ │ │ │ 2 │ description │ ╭───┬───────────────────╮ │ ... │ │ +│ │ │ │ │ │ │ │ │ 0 │ new type of shell │ │ │ │ +│ │ │ │ │ │ │ │ ╰───┴───────────────────╯ │ │ │ +│ │ │ │ │ ╰───┴─────────────┴───────────────────────────┴─────╯ │ +╰────┴──────────┴────────────────┴───────────────────┴───────────────────────────────────────────────────────╯ ``` diff --git a/commands/docs/from_md.md b/commands/docs/from_md.md index 51f2de72de9..d455e6f4636 100644 --- a/commands/docs/from_md.md +++ b/commands/docs/from_md.md @@ -2,7 +2,7 @@ title: from md categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert markdown text into human-friendly structured rows. Use --verbose for the full AST. usage: | diff --git a/commands/docs/from_msgpack.md b/commands/docs/from_msgpack.md index d15429d86b2..f6a85a39337 100644 --- a/commands/docs/from_msgpack.md +++ b/commands/docs/from_msgpack.md @@ -2,7 +2,7 @@ title: from msgpack categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert MessagePack data into Nu values. usage: | diff --git a/commands/docs/from_msgpackz.md b/commands/docs/from_msgpackz.md index cf331e3d16c..1f0e2a834e0 100644 --- a/commands/docs/from_msgpackz.md +++ b/commands/docs/from_msgpackz.md @@ -2,7 +2,7 @@ title: from msgpackz categories: | formats -version: 0.115.1 +version: 0.116.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 7eb67d5c29e..bde13e79ca5 100644 --- a/commands/docs/from_nuon.md +++ b/commands/docs/from_nuon.md @@ -2,7 +2,7 @@ title: from nuon categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert from nuon to structured data. usage: | diff --git a/commands/docs/from_ods.md b/commands/docs/from_ods.md index ddc5deaeefe..291663fcb04 100644 --- a/commands/docs/from_ods.md +++ b/commands/docs/from_ods.md @@ -2,7 +2,7 @@ title: from ods categories: | formats -version: 0.115.1 +version: 0.116.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 d38149ec582..bdd20993a67 100644 --- a/commands/docs/from_plist.md +++ b/commands/docs/from_plist.md @@ -2,7 +2,7 @@ title: from plist categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert plist to Nushell values usage: | diff --git a/commands/docs/from_ssv.md b/commands/docs/from_ssv.md index 43bbf8ad831..fa96ffb947e 100644 --- a/commands/docs/from_ssv.md +++ b/commands/docs/from_ssv.md @@ -2,7 +2,7 @@ title: from ssv categories: | formats -version: 0.115.1 +version: 0.116.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 e1236481075..5f36cef2783 100644 --- a/commands/docs/from_toml.md +++ b/commands/docs/from_toml.md @@ -2,7 +2,7 @@ title: from toml categories: | formats -version: 0.115.1 +version: 0.116.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 54ea2c1367a..5e41ce0837f 100644 --- a/commands/docs/from_tsv.md +++ b/commands/docs/from_tsv.md @@ -2,7 +2,7 @@ title: from tsv categories: | formats -version: 0.115.1 +version: 0.116.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 e6143484e21..5f1af4434ce 100644 --- a/commands/docs/from_url.md +++ b/commands/docs/from_url.md @@ -2,7 +2,7 @@ title: from url categories: | formats -version: 0.115.1 +version: 0.116.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 98e88b457e5..180da803e3f 100644 --- a/commands/docs/from_vcf.md +++ b/commands/docs/from_vcf.md @@ -2,7 +2,7 @@ title: from vcf categories: | formats -version: 0.115.1 +version: 0.116.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 79d0fbbfad9..cfea0ee2a50 100644 --- a/commands/docs/from_xlsx.md +++ b/commands/docs/from_xlsx.md @@ -2,7 +2,7 @@ title: from xlsx categories: | formats -version: 0.115.1 +version: 0.116.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 2dc40594f26..22150d5b648 100644 --- a/commands/docs/from_xml.md +++ b/commands/docs/from_xml.md @@ -2,7 +2,7 @@ title: from xml categories: | formats -version: 0.115.1 +version: 0.116.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 90a44f289e9..a518824d2f8 100644 --- a/commands/docs/from_yaml.md +++ b/commands/docs/from_yaml.md @@ -2,7 +2,7 @@ title: from yaml categories: | formats -version: 0.115.1 +version: 0.116.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 68289792f6d..cf20cf09c05 100644 --- a/commands/docs/from_yml.md +++ b/commands/docs/from_yml.md @@ -2,7 +2,7 @@ title: from yml categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Parse text as .yaml/.yml and create table. usage: | diff --git a/commands/docs/generate.md b/commands/docs/generate.md index b6f1103ccc6..5fceb46296b 100644 --- a/commands/docs/generate.md +++ b/commands/docs/generate.md @@ -2,7 +2,7 @@ title: generate categories: | generators -version: 0.115.1 +version: 0.116.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 c85060a7691..2d7bfd3f24b 100644 --- a/commands/docs/get.md +++ b/commands/docs/get.md @@ -2,7 +2,7 @@ title: get categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Extract data using a cell path. usage: | diff --git a/commands/docs/glob.md b/commands/docs/glob.md index 24cfd2ee69b..6a00af0eb79 100644 --- a/commands/docs/glob.md +++ b/commands/docs/glob.md @@ -2,7 +2,7 @@ title: glob categories: | filesystem -version: 0.115.1 +version: 0.116.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 1621806102e..69530b82ed8 100644 --- a/commands/docs/grid.md +++ b/commands/docs/grid.md @@ -2,7 +2,7 @@ title: grid categories: | viewers -version: 0.115.1 +version: 0.116.0 viewers: | Renders the output to a textual terminal grid. usage: | diff --git a/commands/docs/group-by.md b/commands/docs/group-by.md index d81a1b30eaa..415c5f9bb39 100644 --- a/commands/docs/group-by.md +++ b/commands/docs/group-by.md @@ -2,7 +2,7 @@ title: group-by categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Splits a list or table into groups, and returns a record containing those groups. usage: | diff --git a/commands/docs/gstat.md b/commands/docs/gstat.md index 0159294119d..793b3038e8a 100644 --- a/commands/docs/gstat.md +++ b/commands/docs/gstat.md @@ -2,7 +2,7 @@ title: gstat categories: | prompt -version: 0.115.1 +version: 0.116.0 prompt: | Get the git status of a repo usage: | diff --git a/commands/docs/hash.md b/commands/docs/hash.md index 0b99e954d72..6725622881b 100644 --- a/commands/docs/hash.md +++ b/commands/docs/hash.md @@ -2,7 +2,7 @@ title: hash categories: | hash -version: 0.115.1 +version: 0.116.0 hash: | Apply hash function. usage: | @@ -38,4 +38,5 @@ You must use one of the following subcommands. Using this command as-is will onl | 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 +| [`hash sha256`](/commands/docs/hash_sha256.md) | Hash a value using the sha256 hash algorithm. | built-in | +| [`hash sha512`](/commands/docs/hash_sha512.md) | Hash a value using the sha512 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 4d0e6403faf..f6ab85c44a8 100644 --- a/commands/docs/hash_md5.md +++ b/commands/docs/hash_md5.md @@ -2,7 +2,7 @@ title: hash md5 categories: | hash -version: 0.115.1 +version: 0.116.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 38cc61488ee..f7045b272d2 100644 --- a/commands/docs/hash_sha256.md +++ b/commands/docs/hash_sha256.md @@ -2,7 +2,7 @@ title: hash sha256 categories: | hash -version: 0.115.1 +version: 0.116.0 hash: | Hash a value using the sha256 hash algorithm. usage: | diff --git a/commands/docs/hash_sha512.md b/commands/docs/hash_sha512.md new file mode 100644 index 00000000000..df81342bfb5 --- /dev/null +++ b/commands/docs/hash_sha512.md @@ -0,0 +1,89 @@ +--- +title: hash sha512 +categories: | + hash +version: 0.116.0 +hash: | + Hash a value using the sha512 hash algorithm. +usage: | + Hash a value using the sha512 hash algorithm. +editLink: false +contributors: false +--- + + +# `hash sha512` for [hash](/commands/categories/hash.md) + +
Hash a value using the sha512 hash algorithm.
+ +## Command Type + +`built-in` + +## Signature + +```> hash sha512 {flags} ...rest``` + +## Flags + + - `--binary, -b`: Output binary instead of hexadecimal representation. + +## Parameters + + - `...rest`: Optionally sha512 hash data by cell path. + + +## Input/output types: + +| input | output | +| ------------ | --------------------------- | +| string | oneof<string, binary> | +| binary | oneof<string, binary> | +| list<string> | list<oneof<string, binary>> | +| list<binary> | list<oneof<string, binary>> | +| table | table | +| record | record | +## Examples + +Return the sha512 hash of a string, hex-encoded +```nu +> 'abcdefghijklmnopqrstuvwxyz' | hash sha512 +4dbff86cc2ca1bae1e16468a05cb9881c97f1753bce3619034898faa1aabe429955a1bf8ec483d7421fe3c1646613a59ed5441fb0f321389f77f48a879c7b1f1 +``` + +Return the sha512 hash of a string, as binary +```nu +> 'abcdefghijklmnopqrstuvwxyz' | hash sha512 --binary +Length: 64 (0x40) bytes | null_char printable whitespace ascii_other non_ascii +00000000: 4d bf f8 6c c2 ca 1b ae 1e 16 46 8a 05 cb 98 81 M××l×וו•Fו××× +00000010: c9 7f 17 53 bc e3 61 90 34 89 8f aa 1a ab e4 29 ו•S××a×4××ו××) +00000020: 95 5a 1b f8 ec 48 3d 74 21 fe 3c 16 46 61 3a 59 ×Z•××H=t!×<•Fa:Y +00000030: ed 54 41 fb 0f 32 13 89 f7 7f 48 a8 79 c7 b1 f1 ×TAו2•×וH×y××× + +``` + +Return the sha512 hash of binary data +```nu +> 0x[deadbeef] | hash sha512 + +``` + +Return the sha512 hash of a file's contents +```nu +> open ./nu_0_24_1_windows.zip | hash sha512 + +``` + +Return the sha512 hash of a list of strings +```nu +> [abc def ghi] | hash sha512 +╭───┬────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ 0 │ ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a2192992a274fc1a836ba3c23a3feebbd454d44 │ +│ │ 23643ce80e2a9ac94fa54ca49f │ +│ 1 │ 40a855bf0a93c1019d75dd5b59cd8157608811dd75c5977e07f3bc4be0cad98b22dde4db9ddb429fc2ad3cf9ca379fedf6c1dc │ +│ │ 4d4bb8829f10c2f0ee04a66663 │ +│ 2 │ 366aead3bed29b6d1de2b8d211e791e5dc7a9611b3d4c61c9323128d746e670a69e9690ce5620efc3b36f6d1b655ce36a72a2f │ +│ │ bed4927448b668f1e3f341c0d9 │ +╰───┴────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + +``` diff --git a/commands/docs/headers.md b/commands/docs/headers.md index 063a8f72bc0..17603005b18 100644 --- a/commands/docs/headers.md +++ b/commands/docs/headers.md @@ -2,7 +2,7 @@ title: headers categories: | filters -version: 0.115.1 +version: 0.116.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 fdaaac0a41b..7d41714b2ee 100644 --- a/commands/docs/help.md +++ b/commands/docs/help.md @@ -2,7 +2,7 @@ title: help categories: | core -version: 0.115.1 +version: 0.116.0 core: | Display help information about different parts of Nushell. usage: | diff --git a/commands/docs/help_aliases.md b/commands/docs/help_aliases.md index 856e151c3ee..6d9017863be 100644 --- a/commands/docs/help_aliases.md +++ b/commands/docs/help_aliases.md @@ -2,7 +2,7 @@ title: help aliases categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell aliases. usage: | diff --git a/commands/docs/help_commands.md b/commands/docs/help_commands.md index 56910c3b916..0a2e12372c6 100644 --- a/commands/docs/help_commands.md +++ b/commands/docs/help_commands.md @@ -2,7 +2,7 @@ title: help commands categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell commands. usage: | diff --git a/commands/docs/help_escapes.md b/commands/docs/help_escapes.md index 871132bdd28..b784f3c672a 100644 --- a/commands/docs/help_escapes.md +++ b/commands/docs/help_escapes.md @@ -2,7 +2,7 @@ title: help escapes categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell string escapes. usage: | diff --git a/commands/docs/help_externs.md b/commands/docs/help_externs.md index 778d2bcc4bf..6b8041fceda 100644 --- a/commands/docs/help_externs.md +++ b/commands/docs/help_externs.md @@ -2,7 +2,7 @@ title: help externs categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell externs. usage: | diff --git a/commands/docs/help_modules.md b/commands/docs/help_modules.md index e97c3f81fc2..5ee11bca9b7 100644 --- a/commands/docs/help_modules.md +++ b/commands/docs/help_modules.md @@ -2,7 +2,7 @@ title: help modules categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell modules. usage: | diff --git a/commands/docs/help_operators.md b/commands/docs/help_operators.md index 7e3de28a960..487ee6581e8 100644 --- a/commands/docs/help_operators.md +++ b/commands/docs/help_operators.md @@ -2,7 +2,7 @@ title: help operators categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell operators. usage: | diff --git a/commands/docs/help_pipe-and-redirect.md b/commands/docs/help_pipe-and-redirect.md index e5706f6a86a..8249c5593a6 100644 --- a/commands/docs/help_pipe-and-redirect.md +++ b/commands/docs/help_pipe-and-redirect.md @@ -2,7 +2,7 @@ title: help pipe-and-redirect categories: | core -version: 0.115.1 +version: 0.116.0 core: | Show help on nushell pipes and redirects. usage: | diff --git a/commands/docs/hide-env.md b/commands/docs/hide-env.md index ebdb01e4a4f..4adc46ee4a7 100644 --- a/commands/docs/hide-env.md +++ b/commands/docs/hide-env.md @@ -2,7 +2,7 @@ title: hide-env categories: | core -version: 0.115.1 +version: 0.116.0 core: | Hide environment variables in the current scope. usage: | diff --git a/commands/docs/hide.md b/commands/docs/hide.md index 97cf12af73c..84d3e08a65e 100644 --- a/commands/docs/hide.md +++ b/commands/docs/hide.md @@ -2,7 +2,7 @@ title: hide categories: | core -version: 0.115.1 +version: 0.116.0 core: | Hide definitions in the current scope. usage: | diff --git a/commands/docs/histogram.md b/commands/docs/histogram.md index c789c62bd7d..c427493b133 100644 --- a/commands/docs/histogram.md +++ b/commands/docs/histogram.md @@ -2,7 +2,7 @@ title: histogram categories: | chart -version: 0.115.1 +version: 0.116.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 80e9cfdafc6..83eedf85962 100644 --- a/commands/docs/history.md +++ b/commands/docs/history.md @@ -2,7 +2,7 @@ title: history categories: | history -version: 0.115.1 +version: 0.116.0 history: | Get the command history. usage: | diff --git a/commands/docs/history_import.md b/commands/docs/history_import.md index cd85122b165..74690e4a689 100644 --- a/commands/docs/history_import.md +++ b/commands/docs/history_import.md @@ -2,7 +2,7 @@ title: history import categories: | history -version: 0.115.1 +version: 0.116.0 history: | Import command line history. usage: | diff --git a/commands/docs/history_session.md b/commands/docs/history_session.md index 18077f5defb..030ed9f98dd 100644 --- a/commands/docs/history_session.md +++ b/commands/docs/history_session.md @@ -2,7 +2,7 @@ title: history session categories: | history -version: 0.115.1 +version: 0.116.0 history: | Get the command history session. usage: | diff --git a/commands/docs/http.md b/commands/docs/http.md index 557a6802587..4f849852de8 100644 --- a/commands/docs/http.md +++ b/commands/docs/http.md @@ -2,7 +2,7 @@ title: http categories: | network -version: 0.115.1 +version: 0.116.0 network: | Various commands for working with http methods. usage: | diff --git a/commands/docs/http_delete.md b/commands/docs/http_delete.md index 61edab45b4a..dd1406ab7a7 100644 --- a/commands/docs/http_delete.md +++ b/commands/docs/http_delete.md @@ -2,7 +2,7 @@ title: http delete categories: | network -version: 0.115.1 +version: 0.116.0 network: | Delete the specified resource. usage: | diff --git a/commands/docs/http_get.md b/commands/docs/http_get.md index f3aa9df95e1..18ec037c2c6 100644 --- a/commands/docs/http_get.md +++ b/commands/docs/http_get.md @@ -2,7 +2,7 @@ title: http get categories: | network -version: 0.115.1 +version: 0.116.0 network: | Fetch the contents from a URL. usage: | diff --git a/commands/docs/http_head.md b/commands/docs/http_head.md index ddaa0193bf4..7cac9c9beb0 100644 --- a/commands/docs/http_head.md +++ b/commands/docs/http_head.md @@ -2,7 +2,7 @@ title: http head categories: | network -version: 0.115.1 +version: 0.116.0 network: | Get the headers from a URL. usage: | diff --git a/commands/docs/http_options.md b/commands/docs/http_options.md index 0b558dffb32..8dbf5070fe1 100644 --- a/commands/docs/http_options.md +++ b/commands/docs/http_options.md @@ -2,7 +2,7 @@ title: http options categories: | network -version: 0.115.1 +version: 0.116.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 d8f9dab7066..9c96c8b9cf1 100644 --- a/commands/docs/http_patch.md +++ b/commands/docs/http_patch.md @@ -2,7 +2,7 @@ title: http patch categories: | network -version: 0.115.1 +version: 0.116.0 network: | Send a PATCH request to a URL with a request body. usage: | diff --git a/commands/docs/http_pool.md b/commands/docs/http_pool.md index e708bd86f5f..a2757083da8 100644 --- a/commands/docs/http_pool.md +++ b/commands/docs/http_pool.md @@ -2,7 +2,7 @@ title: http pool categories: | network -version: 0.115.1 +version: 0.116.0 network: | Configure and reset builtin http connection pool. usage: | diff --git a/commands/docs/http_post.md b/commands/docs/http_post.md index 1f4315bdcbf..d61a1d9eeb7 100644 --- a/commands/docs/http_post.md +++ b/commands/docs/http_post.md @@ -2,7 +2,7 @@ title: http post categories: | network -version: 0.115.1 +version: 0.116.0 network: | Send a POST request to a URL with a request body. usage: | diff --git a/commands/docs/http_put.md b/commands/docs/http_put.md index 711a7ef4854..07f5962b014 100644 --- a/commands/docs/http_put.md +++ b/commands/docs/http_put.md @@ -2,7 +2,7 @@ title: http put categories: | network -version: 0.115.1 +version: 0.116.0 network: | Send a PUT request to a URL with a request body. usage: | diff --git a/commands/docs/idx.md b/commands/docs/idx.md index 1fe55c48dd0..005456848a2 100644 --- a/commands/docs/idx.md +++ b/commands/docs/idx.md @@ -2,7 +2,7 @@ title: idx categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Manage in-memory file index state. usage: | diff --git a/commands/docs/idx_dirs.md b/commands/docs/idx_dirs.md index d439e63df05..5336b1e578d 100644 --- a/commands/docs/idx_dirs.md +++ b/commands/docs/idx_dirs.md @@ -2,7 +2,7 @@ title: idx dirs categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | List indexed directories, or fuzzy-match directories by query. usage: | diff --git a/commands/docs/idx_drop.md b/commands/docs/idx_drop.md index f0b9dec4a91..bc87fb447bc 100644 --- a/commands/docs/idx_drop.md +++ b/commands/docs/idx_drop.md @@ -2,7 +2,7 @@ title: idx drop categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Drop the current idx runtime from memory. usage: | diff --git a/commands/docs/idx_files.md b/commands/docs/idx_files.md index 340f773f13a..a0687994afa 100644 --- a/commands/docs/idx_files.md +++ b/commands/docs/idx_files.md @@ -2,7 +2,7 @@ title: idx files categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | List indexed files, or fuzzy-match files by query. usage: | diff --git a/commands/docs/idx_find.md b/commands/docs/idx_find.md index 81b1e822e3f..1fb18ca7588 100644 --- a/commands/docs/idx_find.md +++ b/commands/docs/idx_find.md @@ -2,7 +2,7 @@ title: idx find categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Search idx with fuzzy matching across files and directories by default. usage: | diff --git a/commands/docs/idx_init.md b/commands/docs/idx_init.md index 788796a2d44..f119b2b07eb 100644 --- a/commands/docs/idx_init.md +++ b/commands/docs/idx_init.md @@ -2,7 +2,7 @@ title: idx init categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Initialize the in-memory idx index for a path. usage: | diff --git a/commands/docs/idx_search.md b/commands/docs/idx_search.md index 01c4e283f0c..e8c997f534a 100644 --- a/commands/docs/idx_search.md +++ b/commands/docs/idx_search.md @@ -2,7 +2,7 @@ title: idx search categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Search indexed file contents. usage: | diff --git a/commands/docs/idx_status.md b/commands/docs/idx_status.md index c0317be9a15..083cb0d6b49 100644 --- a/commands/docs/idx_status.md +++ b/commands/docs/idx_status.md @@ -2,7 +2,7 @@ title: idx status categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Show status information for the global in-memory idx runtime. usage: | diff --git a/commands/docs/idx_watch.md b/commands/docs/idx_watch.md index 3af1e1f9a7c..eb8d951c872 100644 --- a/commands/docs/idx_watch.md +++ b/commands/docs/idx_watch.md @@ -2,7 +2,7 @@ title: idx watch categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Stream filesystem change events from the live idx index. usage: | diff --git a/commands/docs/if.md b/commands/docs/if.md index 189c078dd19..8c8bb4ff72b 100644 --- a/commands/docs/if.md +++ b/commands/docs/if.md @@ -2,7 +2,7 @@ title: if categories: | core -version: 0.115.1 +version: 0.116.0 core: | Conditionally run a block. usage: | diff --git a/commands/docs/ignore.md b/commands/docs/ignore.md index f3e36cd0955..b8cf7a7998c 100644 --- a/commands/docs/ignore.md +++ b/commands/docs/ignore.md @@ -2,7 +2,7 @@ title: ignore categories: | core -version: 0.115.1 +version: 0.116.0 core: | Ignore selected output streams from the previous command in the pipeline. usage: | diff --git a/commands/docs/inc.md b/commands/docs/inc.md index acd3e565181..719e3968a11 100644 --- a/commands/docs/inc.md +++ b/commands/docs/inc.md @@ -2,7 +2,7 @@ title: inc categories: | default -version: 0.115.1 +version: 0.116.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 b7d9b61fe49..194ea31bcc4 100644 --- a/commands/docs/input.md +++ b/commands/docs/input.md @@ -2,7 +2,7 @@ title: input categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Get input from the user via the terminal. usage: | diff --git a/commands/docs/input_list.md b/commands/docs/input_list.md index 332302d02c6..f49c18677ce 100644 --- a/commands/docs/input_list.md +++ b/commands/docs/input_list.md @@ -2,7 +2,7 @@ title: input list categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Display an interactive list for user selection. usage: | diff --git a/commands/docs/input_listen.md b/commands/docs/input_listen.md index dac45649412..819797ae24a 100644 --- a/commands/docs/input_listen.md +++ b/commands/docs/input_listen.md @@ -2,7 +2,7 @@ title: input listen categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Listen for user interface events. usage: | diff --git a/commands/docs/insert.md b/commands/docs/insert.md index 2675ab83a45..f766400af94 100644 --- a/commands/docs/insert.md +++ b/commands/docs/insert.md @@ -2,7 +2,7 @@ title: insert categories: | filters -version: 0.115.1 +version: 0.116.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 71ffea9dc1a..88302d290b4 100644 --- a/commands/docs/inspect.md +++ b/commands/docs/inspect.md @@ -2,7 +2,7 @@ title: inspect categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Inspect pipeline results while running a pipeline. usage: | diff --git a/commands/docs/interleave.md b/commands/docs/interleave.md index 3a16e432312..9f49c6c2cff 100644 --- a/commands/docs/interleave.md +++ b/commands/docs/interleave.md @@ -2,7 +2,7 @@ title: interleave categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Read multiple streams in parallel and combine them into one stream. usage: | diff --git a/commands/docs/intersect.md b/commands/docs/intersect.md index 528449c4ac5..9e8f0b1018e 100644 --- a/commands/docs/intersect.md +++ b/commands/docs/intersect.md @@ -2,7 +2,7 @@ title: intersect categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Returns a list of unique elements present in both the input and the provided list. usage: | diff --git a/commands/docs/into.md b/commands/docs/into.md index 8bbd39c4069..93ad5fc350b 100644 --- a/commands/docs/into.md +++ b/commands/docs/into.md @@ -2,7 +2,7 @@ title: into categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Commands to convert data from one type to another. usage: | diff --git a/commands/docs/into_binary.md b/commands/docs/into_binary.md index 8add01edb57..beb08dea0d0 100644 --- a/commands/docs/into_binary.md +++ b/commands/docs/into_binary.md @@ -2,7 +2,7 @@ title: into binary categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a binary primitive. usage: | diff --git a/commands/docs/into_bool.md b/commands/docs/into_bool.md index 96844fd5f63..5b5323ef107 100644 --- a/commands/docs/into_bool.md +++ b/commands/docs/into_bool.md @@ -2,7 +2,7 @@ title: into bool categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a boolean. usage: | diff --git a/commands/docs/into_cell-path.md b/commands/docs/into_cell-path.md index 2028ec057e3..875e529a4ae 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.115.1 +version: 0.116.0 conversions: | Convert value to a cell-path. usage: | diff --git a/commands/docs/into_datetime.md b/commands/docs/into_datetime.md index 97fe698dcbe..0a7b5d3c789 100644 --- a/commands/docs/into_datetime.md +++ b/commands/docs/into_datetime.md @@ -2,7 +2,7 @@ title: into datetime categories: | conversions -version: 0.115.1 +version: 0.116.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 0f9ccf2590c..8232c4dc8f8 100644 --- a/commands/docs/into_duration.md +++ b/commands/docs/into_duration.md @@ -2,7 +2,7 @@ title: into duration categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a duration. usage: | diff --git a/commands/docs/into_filesize.md b/commands/docs/into_filesize.md index 3436a6e376c..0e71a353400 100644 --- a/commands/docs/into_filesize.md +++ b/commands/docs/into_filesize.md @@ -2,7 +2,7 @@ title: into filesize categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a filesize. usage: | diff --git a/commands/docs/into_float.md b/commands/docs/into_float.md index e88d39d2359..f3315124b66 100644 --- a/commands/docs/into_float.md +++ b/commands/docs/into_float.md @@ -2,7 +2,7 @@ title: into float categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert data into floating point number. usage: | diff --git a/commands/docs/into_glob.md b/commands/docs/into_glob.md index b1ae60f071f..bf4728db828 100644 --- a/commands/docs/into_glob.md +++ b/commands/docs/into_glob.md @@ -2,7 +2,7 @@ title: into glob categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a glob pattern. usage: | diff --git a/commands/docs/into_int.md b/commands/docs/into_int.md index d286a44e8c6..b195166fb70 100644 --- a/commands/docs/into_int.md +++ b/commands/docs/into_int.md @@ -2,7 +2,7 @@ title: into int categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to an integer. usage: | diff --git a/commands/docs/into_matrix.md b/commands/docs/into_matrix.md index 4dd2856a5b3..836b3fddc31 100644 --- a/commands/docs/into_matrix.md +++ b/commands/docs/into_matrix.md @@ -2,7 +2,7 @@ title: into matrix categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert a nushell table or list of lists into a matrix. usage: | diff --git a/commands/docs/into_record.md b/commands/docs/into_record.md index def32507329..6a6880e0009 100644 --- a/commands/docs/into_record.md +++ b/commands/docs/into_record.md @@ -2,7 +2,7 @@ title: into record categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a record. usage: | diff --git a/commands/docs/into_semver-range.md b/commands/docs/into_semver-range.md index 11d1cae519f..de1d0c936bf 100644 --- a/commands/docs/into_semver-range.md +++ b/commands/docs/into_semver-range.md @@ -2,7 +2,7 @@ title: into semver-range categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert a string to a semver range. usage: | diff --git a/commands/docs/into_semver.md b/commands/docs/into_semver.md index a1cd0334433..53e7b270ab0 100644 --- a/commands/docs/into_semver.md +++ b/commands/docs/into_semver.md @@ -2,7 +2,7 @@ title: into semver categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert a value (string, record, or semver) to a semantic version. usage: | diff --git a/commands/docs/into_sqlite.md b/commands/docs/into_sqlite.md index 6255811033f..5294cc2ebdc 100644 --- a/commands/docs/into_sqlite.md +++ b/commands/docs/into_sqlite.md @@ -2,7 +2,7 @@ title: into sqlite categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert table into a SQLite database. usage: | diff --git a/commands/docs/into_string.md b/commands/docs/into_string.md index 4b9c44b4725..947d1c997e9 100644 --- a/commands/docs/into_string.md +++ b/commands/docs/into_string.md @@ -2,7 +2,7 @@ title: into string categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert value to a string. usage: | @@ -36,22 +36,24 @@ contributors: false ## Input/output types: -| input | output | -| --------- | ------------ | -| binary | string | -| int | string | -| number | string | -| string | string | -| glob | string | -| bool | string | -| filesize | string | -| datetime | string | -| duration | string | -| cell-path | string | -| range | string | -| list<any> | list<string> | -| table | table | -| record | record | +| input | output | +| ------------ | ------------ | +| binary | string | +| int | string | +| number | string | +| string | string | +| glob | string | +| bool | string | +| filesize | string | +| datetime | string | +| duration | string | +| cell-path | string | +| range | string | +| semver | string | +| semver-range | string | +| list<any> | list<string> | +| table | table | +| record | record | ## Examples convert int to string and append three decimal places. @@ -125,3 +127,9 @@ convert cell-path to string. > $.name | into string $.name ``` + +convert semver to string. +```nu +> '1.2.3' | into semver | into string +1.2.3 +``` diff --git a/commands/docs/into_value.md b/commands/docs/into_value.md index 70da107b473..6f16196aef4 100644 --- a/commands/docs/into_value.md +++ b/commands/docs/into_value.md @@ -2,7 +2,7 @@ title: into value categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert custom values into base values. usage: | diff --git a/commands/docs/is-admin.md b/commands/docs/is-admin.md index f9cd3926860..2adcb0ac8ab 100644 --- a/commands/docs/is-admin.md +++ b/commands/docs/is-admin.md @@ -2,7 +2,7 @@ title: is-admin categories: | core -version: 0.115.1 +version: 0.116.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 92de44b2690..3c73bf27fde 100644 --- a/commands/docs/is-empty.md +++ b/commands/docs/is-empty.md @@ -2,7 +2,7 @@ title: is-empty categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Check for empty values. usage: | diff --git a/commands/docs/is-not-empty.md b/commands/docs/is-not-empty.md index 0968baa6462..05f757eb46e 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.115.1 +version: 0.116.0 filters: | Check for non-empty values. usage: | diff --git a/commands/docs/is-redirected.md b/commands/docs/is-redirected.md index 8fa95990301..b417e03ada1 100644 --- a/commands/docs/is-redirected.md +++ b/commands/docs/is-redirected.md @@ -2,7 +2,7 @@ title: is-redirected categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Check if the current custom command's return value is redirected away from display. usage: | diff --git a/commands/docs/is-terminal.md b/commands/docs/is-terminal.md index 516c88c44c1..2bbaad2e465 100644 --- a/commands/docs/is-terminal.md +++ b/commands/docs/is-terminal.md @@ -2,7 +2,7 @@ title: is-terminal categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Check if the process stdin, stdout, or stderr is attached to a terminal device. usage: | diff --git a/commands/docs/items.md b/commands/docs/items.md index b6a09eec173..dd440ff410d 100644 --- a/commands/docs/items.md +++ b/commands/docs/items.md @@ -2,7 +2,7 @@ title: items categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Given a record, iterate on each pair of column name and associated value. usage: | diff --git a/commands/docs/job.md b/commands/docs/job.md index d84ac21b845..f78a5473f0e 100644 --- a/commands/docs/job.md +++ b/commands/docs/job.md @@ -2,7 +2,7 @@ title: job categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Various commands for working with background jobs. usage: | diff --git a/commands/docs/job_describe.md b/commands/docs/job_describe.md index 4d7c1f83b83..676ae69e32d 100644 --- a/commands/docs/job_describe.md +++ b/commands/docs/job_describe.md @@ -2,7 +2,7 @@ title: job describe categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Add a description to a background job. usage: | diff --git a/commands/docs/job_flush.md b/commands/docs/job_flush.md index d1efa58cca8..1db1dff22af 100644 --- a/commands/docs/job_flush.md +++ b/commands/docs/job_flush.md @@ -2,7 +2,7 @@ title: job flush categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Clear this job's mailbox. usage: | diff --git a/commands/docs/job_id.md b/commands/docs/job_id.md index 796893c8d75..c285f754e33 100644 --- a/commands/docs/job_id.md +++ b/commands/docs/job_id.md @@ -2,7 +2,7 @@ title: job id categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Get id of current job. usage: | diff --git a/commands/docs/job_kill.md b/commands/docs/job_kill.md index 155a4eb78f7..544776bbf38 100644 --- a/commands/docs/job_kill.md +++ b/commands/docs/job_kill.md @@ -2,7 +2,7 @@ title: job kill categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Kill a background job. usage: | diff --git a/commands/docs/job_list.md b/commands/docs/job_list.md index a09af40b141..6e88eee1e72 100644 --- a/commands/docs/job_list.md +++ b/commands/docs/job_list.md @@ -2,7 +2,7 @@ title: job list categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | List background jobs. usage: | diff --git a/commands/docs/job_recv.md b/commands/docs/job_recv.md index 722cab9415e..f4207502cf4 100644 --- a/commands/docs/job_recv.md +++ b/commands/docs/job_recv.md @@ -2,7 +2,7 @@ title: job recv categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Read a message from a job's mailbox. usage: | diff --git a/commands/docs/job_send.md b/commands/docs/job_send.md index d47a3c0aa5e..3d859114795 100644 --- a/commands/docs/job_send.md +++ b/commands/docs/job_send.md @@ -2,7 +2,7 @@ title: job send categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Send a message to the mailbox of a job. usage: | diff --git a/commands/docs/job_spawn.md b/commands/docs/job_spawn.md index 972f54e9d81..90b41c39a4f 100644 --- a/commands/docs/job_spawn.md +++ b/commands/docs/job_spawn.md @@ -2,7 +2,7 @@ title: job spawn categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Spawn a background job and retrieve its ID. usage: | diff --git a/commands/docs/job_unfreeze.md b/commands/docs/job_unfreeze.md index 3b2ba8df667..2baad6e4c9e 100644 --- a/commands/docs/job_unfreeze.md +++ b/commands/docs/job_unfreeze.md @@ -2,7 +2,7 @@ title: job unfreeze categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Unfreeze a frozen process job in foreground. usage: | diff --git a/commands/docs/join.md b/commands/docs/join.md index 0fea8efcefc..33acf0174a9 100644 --- a/commands/docs/join.md +++ b/commands/docs/join.md @@ -2,7 +2,7 @@ title: join categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Join two tables. usage: | diff --git a/commands/docs/keybindings.md b/commands/docs/keybindings.md index c4a378db99c..06313d4649a 100644 --- a/commands/docs/keybindings.md +++ b/commands/docs/keybindings.md @@ -2,7 +2,7 @@ title: keybindings categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Keybindings related commands. usage: | diff --git a/commands/docs/keybindings_default.md b/commands/docs/keybindings_default.md index aa844f62503..b28f7c3464e 100644 --- a/commands/docs/keybindings_default.md +++ b/commands/docs/keybindings_default.md @@ -2,7 +2,7 @@ title: keybindings default categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | List default keybindings. usage: | diff --git a/commands/docs/keybindings_list.md b/commands/docs/keybindings_list.md index 7b781afee60..d8a5a5572c6 100644 --- a/commands/docs/keybindings_list.md +++ b/commands/docs/keybindings_list.md @@ -2,7 +2,7 @@ title: keybindings list categories: | platform -version: 0.115.1 +version: 0.116.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 899909fbdb0..fba3b8753c4 100644 --- a/commands/docs/keybindings_listen.md +++ b/commands/docs/keybindings_listen.md @@ -2,7 +2,7 @@ title: keybindings listen categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Get input from the user. usage: | diff --git a/commands/docs/kill.md b/commands/docs/kill.md index edb836b3515..032985a49c7 100644 --- a/commands/docs/kill.md +++ b/commands/docs/kill.md @@ -2,7 +2,7 @@ title: kill categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Kill a process using its process ID. usage: | diff --git a/commands/docs/last.md b/commands/docs/last.md index 5e6e1a59832..b56e834356e 100644 --- a/commands/docs/last.md +++ b/commands/docs/last.md @@ -2,7 +2,7 @@ title: last categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Return only the last several rows of the input. Counterpart of `first`. Opposite of `drop`. For binary input, rows can also be specified as a filesize. usage: | diff --git a/commands/docs/length.md b/commands/docs/length.md index 51077836ed3..86e2f5da716 100644 --- a/commands/docs/length.md +++ b/commands/docs/length.md @@ -2,7 +2,7 @@ title: length categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Count the number of items in an input list, rows in a table, or bytes in binary data. usage: | diff --git a/commands/docs/let-env.md b/commands/docs/let-env.md index 1bbeed71409..ca488e7f1a1 100644 --- a/commands/docs/let-env.md +++ b/commands/docs/let-env.md @@ -2,7 +2,7 @@ title: let-env categories: | removed -version: 0.115.1 +version: 0.116.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 26946b42883..159a1969890 100644 --- a/commands/docs/let.md +++ b/commands/docs/let.md @@ -2,7 +2,7 @@ title: let categories: | core -version: 0.115.1 +version: 0.116.0 core: | Create a variable and give it a value. usage: | diff --git a/commands/docs/lines.md b/commands/docs/lines.md index da8c6c3e037..f8705a8905b 100644 --- a/commands/docs/lines.md +++ b/commands/docs/lines.md @@ -2,7 +2,7 @@ title: lines categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Converts input to lines. usage: | @@ -46,3 +46,13 @@ Split multi-line string into lines ╰───┴───────╯ ``` + +Skip empty lines +```nu +> "foo\n\nbar" | lines --skip-empty +╭───┬─────╮ +│ 0 │ foo │ +│ 1 │ bar │ +╰───┴─────╯ + +``` diff --git a/commands/docs/load-env.md b/commands/docs/load-env.md index 8c3314f8307..e1f2dc7d52e 100644 --- a/commands/docs/load-env.md +++ b/commands/docs/load-env.md @@ -2,7 +2,7 @@ title: load-env categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Loads an environment update from a record. usage: | @@ -49,3 +49,16 @@ Load variables from an argument. > load-env {NAME: ABE, AGE: UNKNOWN}; $env.NAME ABE ``` + +Load a variable, then apply its environment conversion. +```nu +> $env.ENV_CONVERSIONS = {MY_ENV_VAR: {from_string: { split row ':' }}}; load-env {MY_ENV_VAR: 'foo:bar'}; $env.ENV_CONVERSIONS = $env.ENV_CONVERSIONS; $env.MY_ENV_VAR +╭───┬─────╮ +│ 0 │ foo │ +│ 1 │ bar │ +╰───┴─────╯ + +``` + +## Notes +Environment conversions are not applied automatically. To apply the conversions configured in $env.ENV_CONVERSIONS after loading an update, assign $env.ENV_CONVERSIONS to itself. \ No newline at end of file diff --git a/commands/docs/loop.md b/commands/docs/loop.md index 63b6bae7d54..d49839cf851 100644 --- a/commands/docs/loop.md +++ b/commands/docs/loop.md @@ -2,7 +2,7 @@ title: loop categories: | core -version: 0.115.1 +version: 0.116.0 core: | Run a block in a loop. usage: | diff --git a/commands/docs/ls.md b/commands/docs/ls.md index 488a0261e65..39e222eba22 100644 --- a/commands/docs/ls.md +++ b/commands/docs/ls.md @@ -2,7 +2,7 @@ title: ls categories: | filesystem -version: 0.115.1 +version: 0.116.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 0fb3928c70e..1a0e976047a 100644 --- a/commands/docs/match.md +++ b/commands/docs/match.md @@ -2,7 +2,7 @@ title: match categories: | core -version: 0.115.1 +version: 0.116.0 core: | Conditionally run a block on a matched value. usage: | diff --git a/commands/docs/math.md b/commands/docs/math.md index 04abcd8617e..4c53378c10c 100644 --- a/commands/docs/math.md +++ b/commands/docs/math.md @@ -2,7 +2,7 @@ title: math categories: | math -version: 0.115.1 +version: 0.116.0 math: | Use mathematical functions as aggregate functions on a list of numbers or tables. usage: | diff --git a/commands/docs/math_abs.md b/commands/docs/math_abs.md index 59dc0e1bf53..5278e527fb5 100644 --- a/commands/docs/math_abs.md +++ b/commands/docs/math_abs.md @@ -2,7 +2,7 @@ title: math abs categories: | math -version: 0.115.1 +version: 0.116.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 78a7b7feeaf..859d73118c8 100644 --- a/commands/docs/math_arccos.md +++ b/commands/docs/math_arccos.md @@ -2,7 +2,7 @@ title: math arccos categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the arccosine of the number. usage: | diff --git a/commands/docs/math_arccosh.md b/commands/docs/math_arccosh.md index 1371ecb8f30..913c31650e6 100644 --- a/commands/docs/math_arccosh.md +++ b/commands/docs/math_arccosh.md @@ -2,7 +2,7 @@ title: math arccosh categories: | math -version: 0.115.1 +version: 0.116.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 8d7affd9aa1..09acd5eb53f 100644 --- a/commands/docs/math_arcsin.md +++ b/commands/docs/math_arcsin.md @@ -2,7 +2,7 @@ title: math arcsin categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the arcsine of the number. usage: | diff --git a/commands/docs/math_arcsinh.md b/commands/docs/math_arcsinh.md index b1693c58ee7..498903b25bc 100644 --- a/commands/docs/math_arcsinh.md +++ b/commands/docs/math_arcsinh.md @@ -2,7 +2,7 @@ title: math arcsinh categories: | math -version: 0.115.1 +version: 0.116.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 3bbb754f134..449cb2d9276 100644 --- a/commands/docs/math_arctan.md +++ b/commands/docs/math_arctan.md @@ -2,7 +2,7 @@ title: math arctan categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the arctangent of the number. usage: | diff --git a/commands/docs/math_arctanh.md b/commands/docs/math_arctanh.md index 36203378289..41ed33683da 100644 --- a/commands/docs/math_arctanh.md +++ b/commands/docs/math_arctanh.md @@ -2,7 +2,7 @@ title: math arctanh categories: | math -version: 0.115.1 +version: 0.116.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 5fe39fe0e2a..da0a9c6557d 100644 --- a/commands/docs/math_avg.md +++ b/commands/docs/math_avg.md @@ -2,7 +2,7 @@ title: math avg categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the average of a list of numbers. usage: | diff --git a/commands/docs/math_cbrt.md b/commands/docs/math_cbrt.md index 551e2b4cf8f..cdb1c6ad1cf 100644 --- a/commands/docs/math_cbrt.md +++ b/commands/docs/math_cbrt.md @@ -2,7 +2,7 @@ title: math cbrt categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the real-valued cube root of the input number. usage: | diff --git a/commands/docs/math_ceil.md b/commands/docs/math_ceil.md index 0da8ee5044e..9c1e3b8650b 100644 --- a/commands/docs/math_ceil.md +++ b/commands/docs/math_ceil.md @@ -2,7 +2,7 @@ title: math ceil categories: | math -version: 0.115.1 +version: 0.116.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 ad5e3e936f5..0f8c2049483 100644 --- a/commands/docs/math_cos.md +++ b/commands/docs/math_cos.md @@ -2,7 +2,7 @@ title: math cos categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the cosine of the number. usage: | diff --git a/commands/docs/math_cosh.md b/commands/docs/math_cosh.md index 07b46fe0f2b..de460aedbd3 100644 --- a/commands/docs/math_cosh.md +++ b/commands/docs/math_cosh.md @@ -2,7 +2,7 @@ title: math cosh categories: | math -version: 0.115.1 +version: 0.116.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 c1339c8596a..b7ffa3c804d 100644 --- a/commands/docs/math_exp.md +++ b/commands/docs/math_exp.md @@ -2,7 +2,7 @@ title: math exp categories: | math -version: 0.115.1 +version: 0.116.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 3b232b8d46a..038fd9dbdd1 100644 --- a/commands/docs/math_floor.md +++ b/commands/docs/math_floor.md @@ -2,7 +2,7 @@ title: math floor categories: | math -version: 0.115.1 +version: 0.116.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 f16f1904c9b..12136ba6335 100644 --- a/commands/docs/math_ln.md +++ b/commands/docs/math_ln.md @@ -2,7 +2,7 @@ title: math ln categories: | math -version: 0.115.1 +version: 0.116.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 da2b567a818..bf1b0beb53d 100644 --- a/commands/docs/math_log.md +++ b/commands/docs/math_log.md @@ -2,7 +2,7 @@ title: math log categories: | math -version: 0.115.1 +version: 0.116.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 57aece6b99c..a9e82899af7 100644 --- a/commands/docs/math_max.md +++ b/commands/docs/math_max.md @@ -2,7 +2,7 @@ title: math max categories: | math -version: 0.115.1 +version: 0.116.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 3bfa873485a..65c986ae9a8 100644 --- a/commands/docs/math_median.md +++ b/commands/docs/math_median.md @@ -2,7 +2,7 @@ title: math median categories: | math -version: 0.115.1 +version: 0.116.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 f1f0d2ebc65..a036e2b8f0a 100644 --- a/commands/docs/math_min.md +++ b/commands/docs/math_min.md @@ -2,7 +2,7 @@ title: math min categories: | math -version: 0.115.1 +version: 0.116.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 431419e8caf..8417b0660d1 100644 --- a/commands/docs/math_mode.md +++ b/commands/docs/math_mode.md @@ -2,7 +2,7 @@ title: math mode categories: | math -version: 0.115.1 +version: 0.116.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 67028c54102..4f2369febb3 100644 --- a/commands/docs/math_product.md +++ b/commands/docs/math_product.md @@ -2,7 +2,7 @@ title: math product categories: | math -version: 0.115.1 +version: 0.116.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 2316c08fd61..499acadb808 100644 --- a/commands/docs/math_round.md +++ b/commands/docs/math_round.md @@ -2,7 +2,7 @@ title: math round categories: | math -version: 0.115.1 +version: 0.116.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 e8b4afe4e28..12c1e63d7ac 100644 --- a/commands/docs/math_sin.md +++ b/commands/docs/math_sin.md @@ -2,7 +2,7 @@ title: math sin categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the sine of the number. usage: | diff --git a/commands/docs/math_sinh.md b/commands/docs/math_sinh.md index b28f0fb5b00..0755d306918 100644 --- a/commands/docs/math_sinh.md +++ b/commands/docs/math_sinh.md @@ -2,7 +2,7 @@ title: math sinh categories: | math -version: 0.115.1 +version: 0.116.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 13fe1e8229d..4957c4f5af4 100644 --- a/commands/docs/math_sqrt.md +++ b/commands/docs/math_sqrt.md @@ -2,7 +2,7 @@ title: math sqrt categories: | math -version: 0.115.1 +version: 0.116.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 aa3167f099e..65b0fc512b6 100644 --- a/commands/docs/math_stddev.md +++ b/commands/docs/math_stddev.md @@ -2,7 +2,7 @@ title: math stddev categories: | math -version: 0.115.1 +version: 0.116.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 b92f77f85be..76a843a7edf 100644 --- a/commands/docs/math_sum.md +++ b/commands/docs/math_sum.md @@ -2,7 +2,7 @@ title: math sum categories: | math -version: 0.115.1 +version: 0.116.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 27ffe82aa70..bbdc1aebb98 100644 --- a/commands/docs/math_tan.md +++ b/commands/docs/math_tan.md @@ -2,7 +2,7 @@ title: math tan categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the tangent of the number. usage: | diff --git a/commands/docs/math_tanh.md b/commands/docs/math_tanh.md index 7b1c7e1a4cd..b809e617522 100644 --- a/commands/docs/math_tanh.md +++ b/commands/docs/math_tanh.md @@ -2,7 +2,7 @@ title: math tanh categories: | math -version: 0.115.1 +version: 0.116.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 296b935d1d4..7c8afa47a33 100644 --- a/commands/docs/math_variance.md +++ b/commands/docs/math_variance.md @@ -2,7 +2,7 @@ title: math variance categories: | math -version: 0.115.1 +version: 0.116.0 math: | Returns the variance of a list of numbers or of each column in a table. usage: | diff --git a/commands/docs/matrix.md b/commands/docs/matrix.md index 6f7f037c67d..0dc42d38e21 100644 --- a/commands/docs/matrix.md +++ b/commands/docs/matrix.md @@ -2,7 +2,7 @@ title: matrix categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Various commands for working with matrices. usage: | diff --git a/commands/docs/matrix_add.md b/commands/docs/matrix_add.md index 5a91c5e0a55..5ddfd7f85e9 100644 --- a/commands/docs/matrix_add.md +++ b/commands/docs/matrix_add.md @@ -2,7 +2,7 @@ title: matrix add categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Add a matrix or scalar to a matrix. usage: | diff --git a/commands/docs/matrix_get-col.md b/commands/docs/matrix_get-col.md index 8dcd23a0cf2..0d9daa32fe6 100644 --- a/commands/docs/matrix_get-col.md +++ b/commands/docs/matrix_get-col.md @@ -2,7 +2,7 @@ title: matrix get-col categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Extract a column from a 2D matrix. usage: | diff --git a/commands/docs/matrix_get-row.md b/commands/docs/matrix_get-row.md index 0919b4916c6..657158751db 100644 --- a/commands/docs/matrix_get-row.md +++ b/commands/docs/matrix_get-row.md @@ -2,7 +2,7 @@ title: matrix get-row categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Extract a row from a matrix. usage: | diff --git a/commands/docs/matrix_identity.md b/commands/docs/matrix_identity.md index 92b6361707c..bec5165339d 100644 --- a/commands/docs/matrix_identity.md +++ b/commands/docs/matrix_identity.md @@ -2,7 +2,7 @@ title: matrix identity categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Create an identity matrix of the given size. usage: | diff --git a/commands/docs/matrix_into-nu.md b/commands/docs/matrix_into-nu.md index 74054dd1c4b..d25169f11b3 100644 --- a/commands/docs/matrix_into-nu.md +++ b/commands/docs/matrix_into-nu.md @@ -2,7 +2,7 @@ title: matrix into-nu categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Convert a matrix to a nushell table (list of lists by default). usage: | diff --git a/commands/docs/matrix_map.md b/commands/docs/matrix_map.md index 77cdbf78c14..263b912a377 100644 --- a/commands/docs/matrix_map.md +++ b/commands/docs/matrix_map.md @@ -2,7 +2,7 @@ title: matrix map categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Apply a closure to each element of a matrix and return a new matrix. usage: | diff --git a/commands/docs/matrix_max.md b/commands/docs/matrix_max.md index a8751da7622..67858347afb 100644 --- a/commands/docs/matrix_max.md +++ b/commands/docs/matrix_max.md @@ -2,7 +2,7 @@ title: matrix max categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Find the maximum value in a matrix, or max along an axis. usage: | diff --git a/commands/docs/matrix_mean.md b/commands/docs/matrix_mean.md index 96b42c84e82..4a828271590 100644 --- a/commands/docs/matrix_mean.md +++ b/commands/docs/matrix_mean.md @@ -2,7 +2,7 @@ title: matrix mean categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Compute the mean of all elements in a matrix. usage: | diff --git a/commands/docs/matrix_multiply.md b/commands/docs/matrix_multiply.md index 29c1877b26f..3a814c340d8 100644 --- a/commands/docs/matrix_multiply.md +++ b/commands/docs/matrix_multiply.md @@ -2,7 +2,7 @@ title: matrix multiply categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Multiply two matrices using dot product. usage: | diff --git a/commands/docs/matrix_reduce.md b/commands/docs/matrix_reduce.md index 5b00785a910..803fed11e80 100644 --- a/commands/docs/matrix_reduce.md +++ b/commands/docs/matrix_reduce.md @@ -2,7 +2,7 @@ title: matrix reduce categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Reduce all elements of a matrix to a single value. usage: | diff --git a/commands/docs/matrix_reshape.md b/commands/docs/matrix_reshape.md index eba6e084590..c452c8cb3aa 100644 --- a/commands/docs/matrix_reshape.md +++ b/commands/docs/matrix_reshape.md @@ -2,7 +2,7 @@ title: matrix reshape categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Change the dimensions of a matrix. usage: | diff --git a/commands/docs/matrix_scale.md b/commands/docs/matrix_scale.md index 61097410d88..fe52b2e484f 100644 --- a/commands/docs/matrix_scale.md +++ b/commands/docs/matrix_scale.md @@ -2,7 +2,7 @@ title: matrix scale categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Multiply all elements of a matrix by a scalar. usage: | diff --git a/commands/docs/matrix_set-col.md b/commands/docs/matrix_set-col.md index b24d57004da..71780d32ccd 100644 --- a/commands/docs/matrix_set-col.md +++ b/commands/docs/matrix_set-col.md @@ -2,7 +2,7 @@ title: matrix set-col categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Replace a column in a 2D matrix. usage: | diff --git a/commands/docs/matrix_set-row.md b/commands/docs/matrix_set-row.md index a7a407db00c..e85c858237f 100644 --- a/commands/docs/matrix_set-row.md +++ b/commands/docs/matrix_set-row.md @@ -2,7 +2,7 @@ title: matrix set-row categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Replace a row in a matrix. usage: | diff --git a/commands/docs/matrix_subtract.md b/commands/docs/matrix_subtract.md index ce4aa8cab8b..5dfcdb5959f 100644 --- a/commands/docs/matrix_subtract.md +++ b/commands/docs/matrix_subtract.md @@ -2,7 +2,7 @@ title: matrix subtract categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Subtract a matrix or scalar from a matrix. usage: | diff --git a/commands/docs/matrix_sum.md b/commands/docs/matrix_sum.md index 4350a3cef06..3bec03e129d 100644 --- a/commands/docs/matrix_sum.md +++ b/commands/docs/matrix_sum.md @@ -2,7 +2,7 @@ title: matrix sum categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Sum all elements of a matrix, or sum along an axis. usage: | diff --git a/commands/docs/matrix_transpose.md b/commands/docs/matrix_transpose.md index 1587309a922..66d991df7f2 100644 --- a/commands/docs/matrix_transpose.md +++ b/commands/docs/matrix_transpose.md @@ -2,7 +2,7 @@ title: matrix transpose categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Transpose a matrix (swap rows and columns). For n-dimensional arrays, reverses all axes. usage: | diff --git a/commands/docs/matrix_zeros.md b/commands/docs/matrix_zeros.md index f75e4e028bf..65bb3b8fac6 100644 --- a/commands/docs/matrix_zeros.md +++ b/commands/docs/matrix_zeros.md @@ -2,7 +2,7 @@ title: matrix zeros categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Create a matrix filled with zeros. usage: | diff --git a/commands/docs/merge.md b/commands/docs/merge.md index 0f247281c57..56dd3dbe5b5 100644 --- a/commands/docs/merge.md +++ b/commands/docs/merge.md @@ -2,7 +2,7 @@ title: merge categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Merge the input with a record or table, overwriting values in matching columns. usage: | diff --git a/commands/docs/merge_deep.md b/commands/docs/merge_deep.md index 2c66121b714..03147426bf9 100644 --- a/commands/docs/merge_deep.md +++ b/commands/docs/merge_deep.md @@ -2,7 +2,7 @@ title: merge deep categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Merge the input with a record or table, recursively merging values in matching columns. usage: | diff --git a/commands/docs/metadata.md b/commands/docs/metadata.md index 331110e097f..7765345cd86 100644 --- a/commands/docs/metadata.md +++ b/commands/docs/metadata.md @@ -2,7 +2,7 @@ title: metadata categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Get the metadata for items in the stream. usage: | diff --git a/commands/docs/metadata_access.md b/commands/docs/metadata_access.md index 3b94b53f176..db348214509 100644 --- a/commands/docs/metadata_access.md +++ b/commands/docs/metadata_access.md @@ -2,7 +2,7 @@ title: metadata access categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Access the metadata for the input stream within a closure. usage: | diff --git a/commands/docs/metadata_set.md b/commands/docs/metadata_set.md index b91c7f8a5da..32f5be06354 100644 --- a/commands/docs/metadata_set.md +++ b/commands/docs/metadata_set.md @@ -2,7 +2,7 @@ title: metadata set categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Set the metadata for items in the stream. usage: | diff --git a/commands/docs/mkdir.md b/commands/docs/mkdir.md index 4a70d96b9ce..ece6e477bfc 100644 --- a/commands/docs/mkdir.md +++ b/commands/docs/mkdir.md @@ -2,7 +2,7 @@ title: mkdir categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Create directories, with intermediary directories if required using uutils/coreutils mkdir. usage: | @@ -27,6 +27,7 @@ contributors: false ## Flags - `--verbose, -v`: Print a message for each created directory. + - `--fail-if-exists`: Error if a target path already exists instead of treating it as success. ## Parameters @@ -47,14 +48,14 @@ Make a directory named foo. ``` -Make multiple directories and show the paths created. +Make a directory, erroring if it already exists. +```nu +> mkdir --fail-if-exists foo + +``` + +Make multiple directories and show the paths created, as absolute paths. ```nu > mkdir -v foo/bar foo2 -╭───┬─────────┬─────────┬───────╮ -│ # │ path │ created │ error │ -├───┼─────────┼─────────┼───────┤ -│ 0 │ foo/bar │ true │ │ -│ 1 │ foo2 │ true │ │ -╰───┴─────────┴─────────┴───────╯ ``` diff --git a/commands/docs/mktemp.md b/commands/docs/mktemp.md index 955730bc35c..3fec2993b99 100644 --- a/commands/docs/mktemp.md +++ b/commands/docs/mktemp.md @@ -2,7 +2,7 @@ title: mktemp categories: | filesystem -version: 0.115.1 +version: 0.116.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 b132db51a82..946bd80a706 100644 --- a/commands/docs/module.md +++ b/commands/docs/module.md @@ -2,7 +2,7 @@ title: module categories: | core -version: 0.115.1 +version: 0.116.0 core: | Define a custom module. usage: | diff --git a/commands/docs/move.md b/commands/docs/move.md index 95fefd9ff3d..44a28754fde 100644 --- a/commands/docs/move.md +++ b/commands/docs/move.md @@ -2,7 +2,7 @@ title: move categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Moves columns relative to other columns or make them the first/last columns. Flags are mutually exclusive. usage: | diff --git a/commands/docs/mut.md b/commands/docs/mut.md index e959b7a09c8..09d2fc45796 100644 --- a/commands/docs/mut.md +++ b/commands/docs/mut.md @@ -2,7 +2,7 @@ title: mut categories: | core -version: 0.115.1 +version: 0.116.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 0887285aff4..b3be912ec1c 100644 --- a/commands/docs/mv.md +++ b/commands/docs/mv.md @@ -2,7 +2,7 @@ title: mv categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Move files or directories using uutils/coreutils mv. usage: | diff --git a/commands/docs/nu-check.md b/commands/docs/nu-check.md index f2e1c626a1e..3f788cccd2d 100644 --- a/commands/docs/nu-check.md +++ b/commands/docs/nu-check.md @@ -2,7 +2,7 @@ title: nu-check categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Validate and parse Nushell input content. usage: | diff --git a/commands/docs/nu-highlight.md b/commands/docs/nu-highlight.md index 22815356a8e..23778659b2d 100644 --- a/commands/docs/nu-highlight.md +++ b/commands/docs/nu-highlight.md @@ -2,7 +2,7 @@ title: nu-highlight categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Syntax highlight the input string. usage: | diff --git a/commands/docs/open.md b/commands/docs/open.md index 87d94a6dcfc..bfc20218e83 100644 --- a/commands/docs/open.md +++ b/commands/docs/open.md @@ -2,7 +2,7 @@ title: open categories: | filesystem -version: 0.115.1 +version: 0.116.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 ae2ace1561d..511157bccf6 100644 --- a/commands/docs/overlay.md +++ b/commands/docs/overlay.md @@ -2,7 +2,7 @@ title: overlay categories: | core -version: 0.115.1 +version: 0.116.0 core: | Commands for manipulating overlays. usage: | diff --git a/commands/docs/overlay_hide.md b/commands/docs/overlay_hide.md index 129ad71da76..a8869893600 100644 --- a/commands/docs/overlay_hide.md +++ b/commands/docs/overlay_hide.md @@ -2,7 +2,7 @@ title: overlay hide categories: | core -version: 0.115.1 +version: 0.116.0 core: | Hide an active overlay. usage: | diff --git a/commands/docs/overlay_list.md b/commands/docs/overlay_list.md index 6c0d09bc160..1e9fb63edad 100644 --- a/commands/docs/overlay_list.md +++ b/commands/docs/overlay_list.md @@ -2,7 +2,7 @@ title: overlay list categories: | core -version: 0.115.1 +version: 0.116.0 core: | List all overlays with their active status. usage: | diff --git a/commands/docs/overlay_new.md b/commands/docs/overlay_new.md index fc262536132..36332b1a3b7 100644 --- a/commands/docs/overlay_new.md +++ b/commands/docs/overlay_new.md @@ -2,7 +2,7 @@ title: overlay new categories: | core -version: 0.115.1 +version: 0.116.0 core: | Create an empty overlay. usage: | diff --git a/commands/docs/overlay_use.md b/commands/docs/overlay_use.md index 4840200432a..09a2d33b6a3 100644 --- a/commands/docs/overlay_use.md +++ b/commands/docs/overlay_use.md @@ -2,7 +2,7 @@ title: overlay use categories: | core -version: 0.115.1 +version: 0.116.0 core: | Use definitions from a module as an overlay. usage: | diff --git a/commands/docs/panic.md b/commands/docs/panic.md index 9f43f53a6a5..e6ff2a4620b 100644 --- a/commands/docs/panic.md +++ b/commands/docs/panic.md @@ -2,7 +2,7 @@ title: panic categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Causes nushell to panic. usage: | diff --git a/commands/docs/par-each.md b/commands/docs/par-each.md index 41548148b59..99ffc38ce0a 100644 --- a/commands/docs/par-each.md +++ b/commands/docs/par-each.md @@ -2,7 +2,7 @@ title: par-each categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Run a closure on each row of the input list in parallel, creating a new list with the results. usage: | @@ -92,4 +92,4 @@ Iterate over each element, producing a list showing indexes of any 2s. ``` ## Notes - Uses a dedicated thread pool (reused across top-level calls; sized by --threads when set). Nested par-each calls use a private pool so they cannot deadlock on the outer pool. \ No newline at end of file + Uses a dedicated thread pool (idle top-level pools are reused; nested or overlapping calls use separate pools). \ No newline at end of file diff --git a/commands/docs/parse.md b/commands/docs/parse.md index 59b0d81e3c3..7cf5b2d16ee 100644 --- a/commands/docs/parse.md +++ b/commands/docs/parse.md @@ -2,7 +2,7 @@ title: parse categories: | strings -version: 0.115.1 +version: 0.116.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 1316e6b02b6..f6fe22a72e8 100644 --- a/commands/docs/path.md +++ b/commands/docs/path.md @@ -2,7 +2,7 @@ title: path categories: | path -version: 0.115.1 +version: 0.116.0 path: | Explore and manipulate paths. usage: | diff --git a/commands/docs/path_basename.md b/commands/docs/path_basename.md index 4c515c3a9ab..fcdd467dd72 100644 --- a/commands/docs/path_basename.md +++ b/commands/docs/path_basename.md @@ -2,7 +2,7 @@ title: path basename categories: | path -version: 0.115.1 +version: 0.116.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 eeba78ecf12..ad94da8358e 100644 --- a/commands/docs/path_dirname.md +++ b/commands/docs/path_dirname.md @@ -2,7 +2,7 @@ title: path dirname categories: | path -version: 0.115.1 +version: 0.116.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 3150c352d06..ce69a2ace23 100644 --- a/commands/docs/path_exists.md +++ b/commands/docs/path_exists.md @@ -2,7 +2,7 @@ title: path exists categories: | path -version: 0.115.1 +version: 0.116.0 path: | Check whether a path exists. usage: | diff --git a/commands/docs/path_expand.md b/commands/docs/path_expand.md index 8c80cffca78..9d60cd6aa39 100644 --- a/commands/docs/path_expand.md +++ b/commands/docs/path_expand.md @@ -2,7 +2,7 @@ title: path expand categories: | path -version: 0.115.1 +version: 0.116.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 342fb180ef5..351f4c5ae02 100644 --- a/commands/docs/path_join.md +++ b/commands/docs/path_join.md @@ -2,7 +2,7 @@ title: path join categories: | path -version: 0.115.1 +version: 0.116.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 b0f077dd9d6..96cff23b078 100644 --- a/commands/docs/path_parse.md +++ b/commands/docs/path_parse.md @@ -2,7 +2,7 @@ title: path parse categories: | path -version: 0.115.1 +version: 0.116.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 a37805f426a..713db63dcfb 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.115.1 +version: 0.116.0 path: | Express a path as relative to another path. usage: | diff --git a/commands/docs/path_self.md b/commands/docs/path_self.md index fac07355d0b..0504634fab5 100644 --- a/commands/docs/path_self.md +++ b/commands/docs/path_self.md @@ -2,7 +2,7 @@ title: path self categories: | path -version: 0.115.1 +version: 0.116.0 path: | Get the absolute path of the script or module containing this command at parse time. usage: | diff --git a/commands/docs/path_split.md b/commands/docs/path_split.md index 44be07e6fcb..a571c6eb1db 100644 --- a/commands/docs/path_split.md +++ b/commands/docs/path_split.md @@ -2,7 +2,7 @@ title: path split categories: | path -version: 0.115.1 +version: 0.116.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 080b3e31371..72e1a12ac0b 100644 --- a/commands/docs/path_type.md +++ b/commands/docs/path_type.md @@ -2,7 +2,7 @@ title: path type categories: | path -version: 0.115.1 +version: 0.116.0 path: | Get the type of the object a path refers to (e.g., file, dir, symlink). usage: | diff --git a/commands/docs/peek.md b/commands/docs/peek.md index 98232e56ae5..137611b97fc 100644 --- a/commands/docs/peek.md +++ b/commands/docs/peek.md @@ -2,7 +2,7 @@ title: peek categories: | default -version: 0.115.1 +version: 0.116.0 default: | Peek the first elements of a stream and store them in the metadata. usage: | diff --git a/commands/docs/permutations.md b/commands/docs/permutations.md index 76e9f3d0996..b7d5ed7e766 100644 --- a/commands/docs/permutations.md +++ b/commands/docs/permutations.md @@ -2,7 +2,7 @@ title: permutations categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Generates all permutations of the input list. usage: | diff --git a/commands/docs/plugin.md b/commands/docs/plugin.md index 1a0df55bc29..d3072bf4e3e 100644 --- a/commands/docs/plugin.md +++ b/commands/docs/plugin.md @@ -2,7 +2,7 @@ title: plugin categories: | plugin -version: 0.115.1 +version: 0.116.0 plugin: | Commands for managing plugins. usage: | diff --git a/commands/docs/plugin_add.md b/commands/docs/plugin_add.md index 2280de2a31a..ec0d85bbb96 100644 --- a/commands/docs/plugin_add.md +++ b/commands/docs/plugin_add.md @@ -2,7 +2,7 @@ title: plugin add categories: | plugin -version: 0.115.1 +version: 0.116.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 b8ef06e0e0d..e2e0b1e2825 100644 --- a/commands/docs/plugin_list.md +++ b/commands/docs/plugin_list.md @@ -2,7 +2,7 @@ title: plugin list categories: | plugin -version: 0.115.1 +version: 0.116.0 plugin: | List loaded and installed plugins. usage: | @@ -41,17 +41,15 @@ contributors: false List installed plugins. ```nu > plugin list -╭───┬──────┬─────────┬─────────┬────────┬───────────────────────────────┬───────┬────────────────────────────╮ -│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ -├───┼──────┼─────────┼─────────┼────────┼───────────────────────────────┼───────┼────────────────────────────┤ -│ 0 │ inc │ 0.115.1 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬──────┬─────────────╮ │ -│ │ │ │ │ │ │ │ │ # │ name │ description │ │ -│ │ │ │ │ │ │ │ ├───┼──────┼─────────────┤ │ -│ │ │ │ │ │ │ │ │ 0 │ inc │ Increment a │ │ -│ │ │ │ │ │ │ │ │ │ │ number by │ │ -│ │ │ │ │ │ │ │ │ │ │ 1. │ │ -│ │ │ │ │ │ │ │ ╰───┴──────┴─────────────╯ │ -╰───┴──────┴─────────┴─────────┴────────┴───────────────────────────────┴───────┴────────────────────────────╯ +╭────┬───────┬─────────────────────┬──────────┬────────┬───────────────────────────────┬───────┬─────────────╮ +│ # │ name │ version │ status │ pid │ filename │ shell │ commands │ +├────┼───────┼─────────────────────┼──────────┼────────┼───────────────────────────────┼───────┼─────────────┤ +│ 0 │ inc │ 0.116.0 │ running │ 106480 │ /opt/nu/plugins/nu_plugin_inc │ │ ╭───┬─────╮ │ +│ │ │ │ │ │ │ │ │ # │ ... │ │ +│ │ │ │ │ │ │ │ ├───┼─────┤ │ +│ │ │ │ │ │ │ │ │ 0 │ ... │ │ +│ │ │ │ │ │ │ │ ╰───┴─────╯ │ +╰────┴───────┴─────────────────────┴──────────┴────────┴───────────────────────────────┴───────┴─────────────╯ ``` diff --git a/commands/docs/plugin_rm.md b/commands/docs/plugin_rm.md index 3443cbdaa3b..4b6a9cc39f5 100644 --- a/commands/docs/plugin_rm.md +++ b/commands/docs/plugin_rm.md @@ -2,7 +2,7 @@ title: plugin rm categories: | plugin -version: 0.115.1 +version: 0.116.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 8eba83bcfe1..3be86902f93 100644 --- a/commands/docs/plugin_stop.md +++ b/commands/docs/plugin_stop.md @@ -2,7 +2,7 @@ title: plugin stop categories: | plugin -version: 0.115.1 +version: 0.116.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 e012d0b4acc..dcb3e4a27d3 100644 --- a/commands/docs/plugin_use.md +++ b/commands/docs/plugin_use.md @@ -2,7 +2,7 @@ title: plugin use categories: | plugin -version: 0.115.1 +version: 0.116.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 2c5c0129efa..3b505e3b768 100644 --- a/commands/docs/polars.md +++ b/commands/docs/polars.md @@ -2,7 +2,7 @@ title: polars categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Operate with data in a dataframe format. usage: | @@ -85,7 +85,11 @@ to the `polars agg` command with some column expressions for aggregation which t | [`polars count-null`](/commands/docs/polars_count-null.md) | Counts null values. | plugin | | [`polars cumulative`](/commands/docs/polars_cumulative.md) | Cumulative calculation for a column or series. | plugin | | [`polars cut`](/commands/docs/polars_cut.md) | Bin continuous values into discrete categories for a series. | plugin | +| [`polars date-range`](/commands/docs/polars_date-range.md) | Create a date range expression. | plugin | +| [`polars date-ranges`](/commands/docs/polars_date-ranges.md) | Create a column of date ranges. | plugin | | [`polars datepart`](/commands/docs/polars_datepart.md) | Creates an expression for capturing the specified datepart in a column. | plugin | +| [`polars datetime-range`](/commands/docs/polars_datetime-range.md) | Create a datetime range expression. | plugin | +| [`polars datetime-ranges`](/commands/docs/polars_datetime-ranges.md) | Create a column of datetime ranges. | 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 | diff --git a/commands/docs/polars_agg-groups.md b/commands/docs/polars_agg-groups.md index e24cc4ba5ac..a182699d671 100644 --- a/commands/docs/polars_agg-groups.md +++ b/commands/docs/polars_agg-groups.md @@ -2,7 +2,7 @@ title: polars agg-groups categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates an agg_groups expression. usage: | diff --git a/commands/docs/polars_agg.md b/commands/docs/polars_agg.md index 054ab006fdd..37be184c080 100644 --- a/commands/docs/polars_agg.md +++ b/commands/docs/polars_agg.md @@ -2,7 +2,7 @@ title: polars agg categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Performs a series of aggregations from a group-by. usage: | diff --git a/commands/docs/polars_all-false.md b/commands/docs/polars_all-false.md index a1e84158b52..f897453853a 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.115.1 +version: 0.116.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 5a41e20ba84..1039058d8e3 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.115.1 +version: 0.116.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 ddb602acd7b..616da40f880 100644 --- a/commands/docs/polars_append.md +++ b/commands/docs/polars_append.md @@ -2,7 +2,7 @@ title: polars append categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Appends a new dataframe. usage: | diff --git a/commands/docs/polars_arg-max.md b/commands/docs/polars_arg-max.md index 35c7ea68871..34ba7340dec 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.115.1 +version: 0.116.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 f685ee99e85..f0a35691070 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.115.1 +version: 0.116.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 39fd49d7281..cec737b1d1e 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.115.1 +version: 0.116.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 523dfef7b67..bb539f4f06b 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.115.1 +version: 0.116.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 fe4cf7c63d5..a3073237db2 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.115.1 +version: 0.116.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 528fde29957..3152d9cebf1 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.115.1 +version: 0.116.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 5cbb0fdd734..865c71e8377 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.115.1 +version: 0.116.0 dataframe: | Converts string to date. usage: | diff --git a/commands/docs/polars_as-datetime.md b/commands/docs/polars_as-datetime.md index 7a64917fecf..c6955f036fe 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.115.1 +version: 0.116.0 dataframe: | Converts string to datetime. usage: | diff --git a/commands/docs/polars_as.md b/commands/docs/polars_as.md index 69bbb37a4a1..fa2b782a675 100644 --- a/commands/docs/polars_as.md +++ b/commands/docs/polars_as.md @@ -2,7 +2,7 @@ title: polars as categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates an alias expression. usage: | diff --git a/commands/docs/polars_cache.md b/commands/docs/polars_cache.md index 3708e12a349..4fb2ea0a3c6 100644 --- a/commands/docs/polars_cache.md +++ b/commands/docs/polars_cache.md @@ -2,7 +2,7 @@ title: polars cache categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Caches operations in a new LazyFrame. usage: | diff --git a/commands/docs/polars_cast.md b/commands/docs/polars_cast.md index 7e2f56ccec3..f45da3a1590 100644 --- a/commands/docs/polars_cast.md +++ b/commands/docs/polars_cast.md @@ -2,7 +2,7 @@ title: polars cast categories: | dataframe -version: 0.115.1 +version: 0.116.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 14d21956dd6..b84d66de427 100644 --- a/commands/docs/polars_col.md +++ b/commands/docs/polars_col.md @@ -2,7 +2,7 @@ title: polars col categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a named column expression. usage: | diff --git a/commands/docs/polars_collect.md b/commands/docs/polars_collect.md index e90058f9bf8..b97f73622ee 100644 --- a/commands/docs/polars_collect.md +++ b/commands/docs/polars_collect.md @@ -2,7 +2,7 @@ title: polars collect categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Collect lazy dataframe into eager dataframe. usage: | diff --git a/commands/docs/polars_columns.md b/commands/docs/polars_columns.md index 19a7d212de0..41b3832d3f6 100644 --- a/commands/docs/polars_columns.md +++ b/commands/docs/polars_columns.md @@ -2,7 +2,7 @@ title: polars columns categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Show dataframe columns. usage: | diff --git a/commands/docs/polars_concat-str.md b/commands/docs/polars_concat-str.md index 49494604015..a737730cd94 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.115.1 +version: 0.116.0 expression: | Creates a concat string expression. usage: | diff --git a/commands/docs/polars_concat.md b/commands/docs/polars_concat.md index e48a853fa91..7c4b3190b0e 100644 --- a/commands/docs/polars_concat.md +++ b/commands/docs/polars_concat.md @@ -2,7 +2,7 @@ title: polars concat categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Concatenate two or more dataframes. usage: | diff --git a/commands/docs/polars_contains.md b/commands/docs/polars_contains.md index 88bbed3d693..82305a93cc8 100644 --- a/commands/docs/polars_contains.md +++ b/commands/docs/polars_contains.md @@ -2,7 +2,7 @@ title: polars contains categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Checks if a pattern is contained in a string. usage: | diff --git a/commands/docs/polars_convert-time-zone.md b/commands/docs/polars_convert-time-zone.md index 08319dc9b17..c72f09b4d9b 100644 --- a/commands/docs/polars_convert-time-zone.md +++ b/commands/docs/polars_convert-time-zone.md @@ -2,7 +2,7 @@ title: polars convert-time-zone categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Convert datetime to target timezone. usage: | diff --git a/commands/docs/polars_count-null.md b/commands/docs/polars_count-null.md index d7043bc498e..0f1d3b71fda 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.115.1 +version: 0.116.0 dataframe: | Counts null values. usage: | diff --git a/commands/docs/polars_count.md b/commands/docs/polars_count.md index 9523968e137..bb60b70b2a3 100644 --- a/commands/docs/polars_count.md +++ b/commands/docs/polars_count.md @@ -2,7 +2,7 @@ title: polars count categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Returns the number of non-null values in the column. usage: | diff --git a/commands/docs/polars_cumulative.md b/commands/docs/polars_cumulative.md index 03ee25d8f51..60e62a886aa 100644 --- a/commands/docs/polars_cumulative.md +++ b/commands/docs/polars_cumulative.md @@ -2,7 +2,7 @@ title: polars cumulative categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Cumulative calculation for a column or series. usage: | diff --git a/commands/docs/polars_cut.md b/commands/docs/polars_cut.md index 625a3eba6e5..810d5ae82ef 100644 --- a/commands/docs/polars_cut.md +++ b/commands/docs/polars_cut.md @@ -2,7 +2,7 @@ title: polars cut categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Bin continuous values into discrete categories for a series. usage: | diff --git a/commands/docs/polars_date-range.md b/commands/docs/polars_date-range.md new file mode 100644 index 00000000000..b0f6eaa8b98 --- /dev/null +++ b/commands/docs/polars_date-range.md @@ -0,0 +1,88 @@ +--- +title: polars date-range +categories: | + dataframe +version: 0.116.0 +dataframe: | + Create a date range expression. +usage: | + Create a date range expression. +editLink: false +contributors: false +--- + + +# `polars date-range` for [dataframe](/commands/categories/dataframe.md) + +
Create a date range expression.
+ +::: warning This command requires a plugin +The `polars date-range` 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. +::: + + +## Command Type + +`plugin` + +## Signature + +```> polars date-range {flags} ``` + +## Flags + + - `--start, -s {any}`: Start of the date range expression. This supports a string, date, or datetime expression. + - `--end, -e {any}`: End of the date range expression. This supports a string, date, or datetime expression. + - `--interval, -i {any}`: Interval of the date range expression. This supports a string or duration expression. + - `--closed, -c {string}`: Closed window of the date range expression. This supports 'left', 'right', 'both', or 'none'. + - `--eager`: Eagerly collect the date range expression into a dataframe. + + +## Input/output types: + +| input | output | +| ----- | ----------------- | +| any | polars_expression | +| any | polars_dataframe | +## Examples + +Eagerly create a column of dates from a start, end, and interval +```nu +> polars date-range --start 2022-01-01 --end 2022-01-05 --interval 1d --eager +╭───┬─────────────╮ +│ # │ literal │ +├───┼─────────────┤ +│ 0 │ 4 years ago │ +│ 1 │ 4 years ago │ +│ 2 │ 4 years ago │ +│ 3 │ 4 years ago │ +│ 4 │ 4 years ago │ +╰───┴─────────────╯ + +``` + +Create a date range per group from the min and max of a date column +```nu +> [[date key]; [2024-01-01 one] [2024-01-02 one] [2024-01-01 two] [2024-01-03 two]] + | polars into-lazy + | polars group-by key + | polars agg (polars date-range --start (polars col date | polars min) --end (polars col date | polars max) --interval 1d | polars as date_range) + | polars collect + | polars sort-by key +╭───┬─────┬───────────────╮ +│ # │ key │ date_range │ +├───┼─────┼───────────────┤ +│ 0 │ one │ ╭───┬───────╮ │ +│ │ │ │ 0 │ 19723 │ │ +│ │ │ │ 1 │ 19724 │ │ +│ │ │ ╰───┴───────╯ │ +│ 1 │ two │ ╭───┬───────╮ │ +│ │ │ │ 0 │ 19723 │ │ +│ │ │ │ 1 │ 19724 │ │ +│ │ │ │ 2 │ 19725 │ │ +│ │ │ ╰───┴───────╯ │ +╰───┴─────┴───────────────╯ + +``` diff --git a/commands/docs/polars_date-ranges.md b/commands/docs/polars_date-ranges.md new file mode 100644 index 00000000000..6b86367f73a --- /dev/null +++ b/commands/docs/polars_date-ranges.md @@ -0,0 +1,87 @@ +--- +title: polars date-ranges +categories: | + dataframe +version: 0.116.0 +dataframe: | + Create a column of date ranges. +usage: | + Create a column of date ranges. +editLink: false +contributors: false +--- + + +# `polars date-ranges` for [dataframe](/commands/categories/dataframe.md) + +
Create a column of date ranges.
+ +::: warning This command requires a plugin +The `polars date-ranges` 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. +::: + + +## Command Type + +`plugin` + +## Signature + +```> polars date-ranges {flags} ``` + +## Flags + + - `--start, -s {any}`: Start of the date range expression. This supports a string, date, or datetime expression. + - `--end, -e {any}`: End of the date range expression. This supports a string, date, or datetime expression. + - `--interval, -i {any}`: Interval of the date range expression. This supports a string or duration expression. + - `--closed, -c {string}`: Closed window of the date range expression. This supports 'left', 'right', 'both', or 'none'. + - `--eager`: Eagerly collect the date range expression into a dataframe. + + +## Input/output types: + +| input | output | +| ----- | ----------------- | +| any | polars_expression | +| any | polars_dataframe | +## Examples + +Eagerly create a column of dates from a start, end, and interval +```nu +> polars date-ranges --start 2022-01-01 --end 2022-01-05 --interval 1d --eager +╭───┬───────────────╮ +│ # │ literal │ +├───┼───────────────┤ +│ 0 │ ╭───┬───────╮ │ +│ │ │ 0 │ 18993 │ │ +│ │ │ 1 │ 18994 │ │ +│ │ │ 2 │ 18995 │ │ +│ │ │ 3 │ 18996 │ │ +│ │ │ 4 │ 18997 │ │ +│ │ ╰───┴───────╯ │ +╰───┴───────────────╯ + +``` + +Create a column of per-row date ranges from start and end date columns +```nu +> [[start end]; [2022-01-01 2022-01-03] [2022-01-02 2022-01-03]] + | polars into-df + | polars select (polars date-ranges --start (polars col start) --end (polars col end) --interval 1d | polars as date_range) +╭───┬───────────────╮ +│ # │ date_range │ +├───┼───────────────┤ +│ 0 │ ╭───┬───────╮ │ +│ │ │ 0 │ 18993 │ │ +│ │ │ 1 │ 18994 │ │ +│ │ │ 2 │ 18995 │ │ +│ │ ╰───┴───────╯ │ +│ 1 │ ╭───┬───────╮ │ +│ │ │ 0 │ 18994 │ │ +│ │ │ 1 │ 18995 │ │ +│ │ ╰───┴───────╯ │ +╰───┴───────────────╯ + +``` diff --git a/commands/docs/polars_datepart.md b/commands/docs/polars_datepart.md index b45ab024f2a..77c720cd053 100644 --- a/commands/docs/polars_datepart.md +++ b/commands/docs/polars_datepart.md @@ -2,7 +2,7 @@ title: polars datepart categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates an expression for capturing the specified datepart in a column. usage: | @@ -65,28 +65,10 @@ Creates an expression to capture multiple date parts (polars col datetime | polars datepart minute | polars as datetime_minute ), (polars col datetime | polars datepart second | polars as datetime_second ), (polars col datetime | polars datepart nanosecond | polars as datetime_ns ) ] -╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬────┬───╮ -│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ da │ d │ -│ │ │ │ │ │ │ │ te │ a │ -│ │ │ │ │ │ │ │ ti │ t │ -│ │ │ │ │ │ │ │ me │ e │ -│ │ │ │ │ │ │ │ _s │ t │ -│ │ │ │ │ │ │ │ ec │ i │ -│ │ │ │ │ │ │ │ on │ m │ -│ │ │ │ │ │ │ │ d │ e │ -│ │ │ │ │ │ │ │ │ _ │ -│ │ │ │ │ │ │ │ │ n │ -│ │ │ │ │ │ │ │ │ s │ -├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼────┼───┤ -│ 0 │ 4 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ 3 │ 1 │ -│ │ │ │ │ │ │ │ │ 2 │ -│ │ │ │ │ │ │ │ │ 3 │ -│ │ │ │ │ │ │ │ │ 4 │ -│ │ │ │ │ │ │ │ │ 5 │ -│ │ │ │ │ │ │ │ │ 6 │ -│ │ │ │ │ │ │ │ │ 7 │ -│ │ │ │ │ │ │ │ │ 8 │ -│ │ │ │ │ │ │ │ │ 9 │ -╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴────┴───╯ +╭───┬─────────────┬───────────────┬────────────────┬──────────────┬───────────────┬─────────────────┬─────╮ +│ # │ datetime │ datetime_year │ datetime_month │ datetime_day │ datetime_hour │ datetime_minute │ ... │ +├───┼─────────────┼───────────────┼────────────────┼──────────────┼───────────────┼─────────────────┼─────┤ +│ 0 │ 4 years ago │ 2021 │ 12 │ 30 │ 1 │ 2 │ ... │ +╰───┴─────────────┴───────────────┴────────────────┴──────────────┴───────────────┴─────────────────┴─────╯ ``` diff --git a/commands/docs/polars_datetime-range.md b/commands/docs/polars_datetime-range.md new file mode 100644 index 00000000000..6520b7d29e0 --- /dev/null +++ b/commands/docs/polars_datetime-range.md @@ -0,0 +1,88 @@ +--- +title: polars datetime-range +categories: | + dataframe +version: 0.116.0 +dataframe: | + Create a datetime range expression. +usage: | + Create a datetime range expression. +editLink: false +contributors: false +--- + + +# `polars datetime-range` for [dataframe](/commands/categories/dataframe.md) + +
Create a datetime range expression.
+ +::: warning This command requires a plugin +The `polars datetime-range` 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. +::: + + +## Command Type + +`plugin` + +## Signature + +```> polars datetime-range {flags} ``` + +## Flags + + - `--start, -s {any}`: Start of the datetime range expression. This supports a string, date, or datetime expression. + - `--end, -e {any}`: End of the datetime range expression. This supports a string, date, or datetime expression. + - `--interval, -i {any}`: Interval of the datetime range expression. This supports a string or duration expression. + - `--closed, -c {string}`: Closed window of the datetime range expression. This supports 'left', 'right', 'both', or 'none'. + - `--time-unit {string}`: Time unit for the output datetime. One of: ns, us, ms. + - `--time-zone {string}`: Time zone for the output datetime. E.g. 'UTC', 'America/New_York'. + - `--eager`: Eagerly collect the datetime range expression into a dataframe. + + +## Input/output types: + +| input | output | +| ----- | ----------------- | +| any | polars_expression | +| any | polars_dataframe | +## Examples + +Eagerly create a column of datetimes from a start, end, and interval +```nu +> polars datetime-range --start 2022-01-01 --end 2022-03-01 --interval 1mo --eager +╭───┬─────────────╮ +│ # │ literal │ +├───┼─────────────┤ +│ 0 │ 4 years ago │ +│ 1 │ 4 years ago │ +│ 2 │ 4 years ago │ +╰───┴─────────────╯ + +``` + +Create a datetime range per group from the min and max of a date column +```nu +> [[date key]; [2024-01-01 one] [2024-01-02 one] [2024-01-01 two] [2024-01-03 two]] + | polars into-lazy + | polars group-by key + | polars agg (polars datetime-range --start (polars col date | polars min) --end (polars col date | polars max) --interval 1d | polars as date_range) + | polars collect + | polars sort-by key +╭───┬─────┬─────────────────────────────╮ +│ # │ key │ date_range │ +├───┼─────┼─────────────────────────────┤ +│ 0 │ one │ ╭───┬─────────────────────╮ │ +│ │ │ │ 0 │ 1704067200000000000 │ │ +│ │ │ │ 1 │ 1704153600000000000 │ │ +│ │ │ ╰───┴─────────────────────╯ │ +│ 1 │ two │ ╭───┬─────────────────────╮ │ +│ │ │ │ 0 │ 1704067200000000000 │ │ +│ │ │ │ 1 │ 1704153600000000000 │ │ +│ │ │ │ 2 │ 1704240000000000000 │ │ +│ │ │ ╰───┴─────────────────────╯ │ +╰───┴─────┴─────────────────────────────╯ + +``` diff --git a/commands/docs/polars_datetime-ranges.md b/commands/docs/polars_datetime-ranges.md new file mode 100644 index 00000000000..835d7966240 --- /dev/null +++ b/commands/docs/polars_datetime-ranges.md @@ -0,0 +1,89 @@ +--- +title: polars datetime-ranges +categories: | + dataframe +version: 0.116.0 +dataframe: | + Create a column of datetime ranges. +usage: | + Create a column of datetime ranges. +editLink: false +contributors: false +--- + + +# `polars datetime-ranges` for [dataframe](/commands/categories/dataframe.md) + +
Create a column of datetime ranges.
+ +::: warning This command requires a plugin +The `polars datetime-ranges` 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. +::: + + +## Command Type + +`plugin` + +## Signature + +```> polars datetime-ranges {flags} ``` + +## Flags + + - `--start, -s {any}`: Start of the datetime range expression. This supports a string, date, or datetime expression. + - `--end, -e {any}`: End of the datetime range expression. This supports a string, date, or datetime expression. + - `--interval, -i {any}`: Interval of the datetime range expression. This supports a string or duration expression. + - `--closed, -c {string}`: Closed window of the datetime range expression. This supports 'left', 'right', 'both', or 'none'. + - `--time-unit {string}`: Time unit for the output datetime. One of: ns, us, ms. + - `--time-zone {string}`: Time zone for the output datetime. E.g. 'UTC', 'America/New_York'. + - `--eager`: Eagerly collect the datetime range expression into a dataframe. + + +## Input/output types: + +| input | output | +| ----- | ----------------- | +| any | polars_expression | +| any | polars_dataframe | +## Examples + +Eagerly create a column of per-row datetime ranges from a start, end, and interval +```nu +> polars datetime-ranges --start 2022-01-01 --end 2022-01-05 --interval 1d --eager +╭───┬─────────────────────────────╮ +│ # │ literal │ +├───┼─────────────────────────────┤ +│ 0 │ ╭───┬─────────────────────╮ │ +│ │ │ 0 │ 1640995200000000000 │ │ +│ │ │ 1 │ 1641081600000000000 │ │ +│ │ │ 2 │ 1641168000000000000 │ │ +│ │ │ 3 │ 1641254400000000000 │ │ +│ │ │ 4 │ 1641340800000000000 │ │ +│ │ ╰───┴─────────────────────╯ │ +╰───┴─────────────────────────────╯ + +``` + +Create a column of per-row datetime ranges from start and end date columns +```nu +> [[start end]; [2022-01-01 2022-01-03] [2022-01-02 2022-01-03]] + | polars into-df + | polars select (polars datetime-ranges --start (polars col start) --end (polars col end) --interval 1d | polars as date_range) +╭───┬─────────────────────────────╮ +│ # │ date_range │ +├───┼─────────────────────────────┤ +│ 0 │ ╭───┬─────────────────────╮ │ +│ │ │ 0 │ 1640995200000000000 │ │ +│ │ │ 1 │ 1641081600000000000 │ │ +│ │ │ 2 │ 1641168000000000000 │ │ +│ │ ╰───┴─────────────────────╯ │ +│ 1 │ ╭───┬─────────────────────╮ │ +│ │ │ 0 │ 1641081600000000000 │ │ +│ │ │ 1 │ 1641168000000000000 │ │ +│ │ ╰───┴─────────────────────╯ │ +╰───┴─────────────────────────────╯ + +``` diff --git a/commands/docs/polars_decimal.md b/commands/docs/polars_decimal.md index 4bf2c7f2900..8069758a922 100644 --- a/commands/docs/polars_decimal.md +++ b/commands/docs/polars_decimal.md @@ -2,7 +2,7 @@ title: polars decimal categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Converts a string column into a decimal column usage: | diff --git a/commands/docs/polars_drop-duplicates.md b/commands/docs/polars_drop-duplicates.md index b661005dd47..d4d68d4d3f0 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.115.1 +version: 0.116.0 dataframe: | Drops duplicate values in dataframe. usage: | diff --git a/commands/docs/polars_drop-nulls.md b/commands/docs/polars_drop-nulls.md index 1cf6824581f..5515b3c2b8e 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.115.1 +version: 0.116.0 dataframe: | Drops null values in dataframe. usage: | diff --git a/commands/docs/polars_drop.md b/commands/docs/polars_drop.md index 700bdf3a0f3..1f39bdff5cb 100644 --- a/commands/docs/polars_drop.md +++ b/commands/docs/polars_drop.md @@ -2,7 +2,7 @@ title: polars drop categories: | dataframe -version: 0.115.1 +version: 0.116.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 0279655b15f..c9f9b5ae456 100644 --- a/commands/docs/polars_dummies.md +++ b/commands/docs/polars_dummies.md @@ -2,7 +2,7 @@ title: polars dummies categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a new dataframe with dummy variables. usage: | diff --git a/commands/docs/polars_entropy.md b/commands/docs/polars_entropy.md index 75cb473bc41..54a833321da 100644 --- a/commands/docs/polars_entropy.md +++ b/commands/docs/polars_entropy.md @@ -2,7 +2,7 @@ title: polars entropy categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the entropy as `-sum(pk * log(pk))` where `pk` are discrete probabilities. usage: | diff --git a/commands/docs/polars_explode.md b/commands/docs/polars_explode.md index 8be3d3caf24..dbf73f05e3f 100644 --- a/commands/docs/polars_explode.md +++ b/commands/docs/polars_explode.md @@ -2,7 +2,7 @@ title: polars explode categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Explodes a dataframe or creates a explode expression. usage: | diff --git a/commands/docs/polars_expr-not.md b/commands/docs/polars_expr-not.md index 3cbbdad3802..2f9d5b8ec8f 100644 --- a/commands/docs/polars_expr-not.md +++ b/commands/docs/polars_expr-not.md @@ -2,7 +2,7 @@ title: polars expr-not categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a not expression. usage: | diff --git a/commands/docs/polars_fill-nan.md b/commands/docs/polars_fill-nan.md index ba37684e5df..b428a3f381c 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.115.1 +version: 0.116.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 c44cfbfd7df..8bac705b51d 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.115.1 +version: 0.116.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 f3feebf7ae5..e438b742259 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.115.1 +version: 0.116.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 64c0d4b9c10..f08bfaa5a65 100644 --- a/commands/docs/polars_filter.md +++ b/commands/docs/polars_filter.md @@ -2,7 +2,7 @@ title: polars filter categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Filter dataframe based in expression. usage: | diff --git a/commands/docs/polars_first.md b/commands/docs/polars_first.md index 25c5639abd4..4076cf2f6c6 100644 --- a/commands/docs/polars_first.md +++ b/commands/docs/polars_first.md @@ -2,7 +2,7 @@ title: polars first categories: | dataframe -version: 0.115.1 +version: 0.116.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 0009c20b146..645301fe135 100644 --- a/commands/docs/polars_flatten.md +++ b/commands/docs/polars_flatten.md @@ -2,7 +2,7 @@ title: polars flatten categories: | lazyframe -version: 0.115.1 +version: 0.116.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 d9234f1eee8..7d2b4939a4b 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.115.1 +version: 0.116.0 dataframe: | Gets day from date. usage: | diff --git a/commands/docs/polars_get-hour.md b/commands/docs/polars_get-hour.md index e1e7b6bc3ce..5913d7d0751 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.115.1 +version: 0.116.0 dataframe: | Gets hour from datetime. usage: | diff --git a/commands/docs/polars_get-minute.md b/commands/docs/polars_get-minute.md index d2ed3a737ac..04b0db2a7e3 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.115.1 +version: 0.116.0 dataframe: | Gets minute from date. usage: | diff --git a/commands/docs/polars_get-month.md b/commands/docs/polars_get-month.md index df71b5f8996..c8460082442 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.115.1 +version: 0.116.0 dataframe: | Gets month from date. usage: | diff --git a/commands/docs/polars_get-nanosecond.md b/commands/docs/polars_get-nanosecond.md index 6f15a7abdf9..7965ac73f9c 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.115.1 +version: 0.116.0 dataframe: | Gets nanosecond from date. usage: | diff --git a/commands/docs/polars_get-ordinal.md b/commands/docs/polars_get-ordinal.md index b4795396707..7646cc92c5e 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.115.1 +version: 0.116.0 dataframe: | Gets ordinal from date. usage: | diff --git a/commands/docs/polars_get-second.md b/commands/docs/polars_get-second.md index aea1a5fd5d7..df43c626ab4 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.115.1 +version: 0.116.0 dataframe: | Gets second from date. usage: | diff --git a/commands/docs/polars_get-week.md b/commands/docs/polars_get-week.md index 608879dec36..c0e45d65d6f 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.115.1 +version: 0.116.0 dataframe: | Gets week from date. usage: | diff --git a/commands/docs/polars_get-weekday.md b/commands/docs/polars_get-weekday.md index a851bd947fe..e94f332a093 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.115.1 +version: 0.116.0 dataframe: | Gets weekday from date. usage: | diff --git a/commands/docs/polars_get-year.md b/commands/docs/polars_get-year.md index dcecff78328..924d6f156a1 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.115.1 +version: 0.116.0 dataframe: | Gets year from date. usage: | diff --git a/commands/docs/polars_get.md b/commands/docs/polars_get.md index f8468a91cd3..506d485a43a 100644 --- a/commands/docs/polars_get.md +++ b/commands/docs/polars_get.md @@ -2,7 +2,7 @@ title: polars get categories: | dataframe -version: 0.115.1 +version: 0.116.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 8ec87d898d8..5dd70683487 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.115.1 +version: 0.116.0 lazyframe: | Creates a group-by object that can be used for other aggregations. usage: | diff --git a/commands/docs/polars_horizontal.md b/commands/docs/polars_horizontal.md index ad5c2eb3389..fca384f4aa2 100644 --- a/commands/docs/polars_horizontal.md +++ b/commands/docs/polars_horizontal.md @@ -2,7 +2,7 @@ title: polars horizontal categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Horizontal calculation across multiple columns. usage: | diff --git a/commands/docs/polars_implode.md b/commands/docs/polars_implode.md index 68cc4869a08..2e2325744d3 100644 --- a/commands/docs/polars_implode.md +++ b/commands/docs/polars_implode.md @@ -2,7 +2,7 @@ title: polars implode categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Aggregates values into a list. usage: | diff --git a/commands/docs/polars_integer.md b/commands/docs/polars_integer.md index 5f88f70dd42..58f9c774739 100644 --- a/commands/docs/polars_integer.md +++ b/commands/docs/polars_integer.md @@ -2,7 +2,7 @@ title: polars integer categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Converts a string column into a integer column usage: | diff --git a/commands/docs/polars_into-df.md b/commands/docs/polars_into-df.md index c6132138044..ba68150652d 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.115.1 +version: 0.116.0 dataframe: | Converts a list, table or record into a dataframe. usage: | diff --git a/commands/docs/polars_into-dtype.md b/commands/docs/polars_into-dtype.md index c959dacc108..c905f58faa1 100644 --- a/commands/docs/polars_into-dtype.md +++ b/commands/docs/polars_into-dtype.md @@ -2,7 +2,7 @@ title: polars into-dtype categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Convert a string to a specific datatype. usage: | diff --git a/commands/docs/polars_into-lazy.md b/commands/docs/polars_into-lazy.md index 960b1986121..ab4a87b15d6 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.115.1 +version: 0.116.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 a9139f00034..9634012c908 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.115.1 +version: 0.116.0 dataframe: | Converts a dataframe or an expression into nushell value for access and exploration. usage: | diff --git a/commands/docs/polars_into-repr.md b/commands/docs/polars_into-repr.md index 79b17b98723..6dd504a0df5 100644 --- a/commands/docs/polars_into-repr.md +++ b/commands/docs/polars_into-repr.md @@ -2,7 +2,7 @@ title: polars into-repr categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Display a dataframe in its repr format. usage: | diff --git a/commands/docs/polars_into-schema.md b/commands/docs/polars_into-schema.md index ef50fc6917d..d66adc2687e 100644 --- a/commands/docs/polars_into-schema.md +++ b/commands/docs/polars_into-schema.md @@ -2,7 +2,7 @@ title: polars into-schema categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Convert a value to a polars schema object usage: | diff --git a/commands/docs/polars_is-duplicated.md b/commands/docs/polars_is-duplicated.md index 78a89bda83d..90c078b7936 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.115.1 +version: 0.116.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 543db5b7c45..e9326dc3d62 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.115.1 +version: 0.116.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 721b382b0af..af1843ec6d6 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.115.1 +version: 0.116.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 d9ff6cfc986..155af3f2c14 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.115.1 +version: 0.116.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 558104c5719..fe13b1eadf6 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.115.1 +version: 0.116.0 dataframe: | Creates mask indicating unique values. usage: | diff --git a/commands/docs/polars_join-where.md b/commands/docs/polars_join-where.md index 246123f7b57..0b29ad6bec3 100644 --- a/commands/docs/polars_join-where.md +++ b/commands/docs/polars_join-where.md @@ -2,7 +2,7 @@ title: polars join-where categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Joins a lazy frame with other lazy frame based on conditions. usage: | diff --git a/commands/docs/polars_join.md b/commands/docs/polars_join.md index e62375a2500..bdb22c176a6 100644 --- a/commands/docs/polars_join.md +++ b/commands/docs/polars_join.md @@ -2,7 +2,7 @@ title: polars join categories: | lazyframe -version: 0.115.1 +version: 0.116.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 ca6744cbdb3..21da8d89c6b 100644 --- a/commands/docs/polars_last.md +++ b/commands/docs/polars_last.md @@ -2,7 +2,7 @@ title: polars last categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates new dataframe with tail rows or creates a last expression. usage: | diff --git a/commands/docs/polars_len.md b/commands/docs/polars_len.md index adf63e70fe5..0c8ac2f5426 100644 --- a/commands/docs/polars_len.md +++ b/commands/docs/polars_len.md @@ -2,7 +2,7 @@ title: polars len categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Return the number of rows in the context. This is similar to COUNT(*) in SQL. usage: | diff --git a/commands/docs/polars_list-contains.md b/commands/docs/polars_list-contains.md index b66f47836c2..ad79baef502 100644 --- a/commands/docs/polars_list-contains.md +++ b/commands/docs/polars_list-contains.md @@ -2,7 +2,7 @@ title: polars list-contains categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Checks if an element is contained in a list. usage: | diff --git a/commands/docs/polars_lit.md b/commands/docs/polars_lit.md index 8579c4566e6..56bebb10a83 100644 --- a/commands/docs/polars_lit.md +++ b/commands/docs/polars_lit.md @@ -2,7 +2,7 @@ title: polars lit categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a literal expression. usage: | diff --git a/commands/docs/polars_lowercase.md b/commands/docs/polars_lowercase.md index 3c227eb34e1..43d824e5fb9 100644 --- a/commands/docs/polars_lowercase.md +++ b/commands/docs/polars_lowercase.md @@ -2,7 +2,7 @@ title: polars lowercase categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Lowercase the strings in the column. usage: | diff --git a/commands/docs/polars_map-batches.md b/commands/docs/polars_map-batches.md index 87259e85ce8..014189404e4 100644 --- a/commands/docs/polars_map-batches.md +++ b/commands/docs/polars_map-batches.md @@ -2,7 +2,7 @@ title: polars map-batches categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Map a custom Nushell closure over one or more dataframe columns. usage: | diff --git a/commands/docs/polars_math.md b/commands/docs/polars_math.md index c0a42920e7f..b9bd3fb5ae0 100644 --- a/commands/docs/polars_math.md +++ b/commands/docs/polars_math.md @@ -2,7 +2,7 @@ title: polars math categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Collection of math functions to be applied on column expressions. usage: | diff --git a/commands/docs/polars_math_abs.md b/commands/docs/polars_math_abs.md index 2441a70d7d4..8efdaa61e39 100644 --- a/commands/docs/polars_math_abs.md +++ b/commands/docs/polars_math_abs.md @@ -2,7 +2,7 @@ title: polars math abs categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the absolute values of a column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-and.md b/commands/docs/polars_math_bitwise-and.md index a2cc9f52c8f..3653f735785 100644 --- a/commands/docs/polars_math_bitwise-and.md +++ b/commands/docs/polars_math_bitwise-and.md @@ -2,7 +2,7 @@ title: polars math bitwise-and categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Perform an aggregation of bitwise ANDs over a column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-count-ones.md b/commands/docs/polars_math_bitwise-count-ones.md index 375180b3c09..1291b97e06b 100644 --- a/commands/docs/polars_math_bitwise-count-ones.md +++ b/commands/docs/polars_math_bitwise-count-ones.md @@ -2,7 +2,7 @@ title: polars math bitwise-count-ones categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the number of set bits for each element in an integer column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-count-zeros.md b/commands/docs/polars_math_bitwise-count-zeros.md index e89ffe31925..3f82fde9c6d 100644 --- a/commands/docs/polars_math_bitwise-count-zeros.md +++ b/commands/docs/polars_math_bitwise-count-zeros.md @@ -2,7 +2,7 @@ title: polars math bitwise-count-zeros categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the number of unset bits for each element in an integer column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-leading-ones.md b/commands/docs/polars_math_bitwise-leading-ones.md index 39fa5374788..84ca06c1b7c 100644 --- a/commands/docs/polars_math_bitwise-leading-ones.md +++ b/commands/docs/polars_math_bitwise-leading-ones.md @@ -2,7 +2,7 @@ title: polars math bitwise-leading-ones categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the number of leading set bits for each element in an integer column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-leading-zeros.md b/commands/docs/polars_math_bitwise-leading-zeros.md index 311c82fdf73..1791b021fce 100644 --- a/commands/docs/polars_math_bitwise-leading-zeros.md +++ b/commands/docs/polars_math_bitwise-leading-zeros.md @@ -2,7 +2,7 @@ title: polars math bitwise-leading-zeros categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the number of leading unset bits for each element in an integer column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-or.md b/commands/docs/polars_math_bitwise-or.md index 0cccc9222e0..b3d9944e7aa 100644 --- a/commands/docs/polars_math_bitwise-or.md +++ b/commands/docs/polars_math_bitwise-or.md @@ -2,7 +2,7 @@ title: polars math bitwise-or categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Perform an aggregation of bitwise ORs over a column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-trailing-ones.md b/commands/docs/polars_math_bitwise-trailing-ones.md index f3bd381ce74..c501fd412d7 100644 --- a/commands/docs/polars_math_bitwise-trailing-ones.md +++ b/commands/docs/polars_math_bitwise-trailing-ones.md @@ -2,7 +2,7 @@ title: polars math bitwise-trailing-ones categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the number of trailing set bits for each element in an integer column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-trailing-zeros.md b/commands/docs/polars_math_bitwise-trailing-zeros.md index 64b66b6d33f..4d8fe8d9a9f 100644 --- a/commands/docs/polars_math_bitwise-trailing-zeros.md +++ b/commands/docs/polars_math_bitwise-trailing-zeros.md @@ -2,7 +2,7 @@ title: polars math bitwise-trailing-zeros categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the number of trailing unset bits for each element in an integer column expression. usage: | diff --git a/commands/docs/polars_math_bitwise-xor.md b/commands/docs/polars_math_bitwise-xor.md index 18119b4bac1..a6a71309630 100644 --- a/commands/docs/polars_math_bitwise-xor.md +++ b/commands/docs/polars_math_bitwise-xor.md @@ -2,7 +2,7 @@ title: polars math bitwise-xor categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Perform an aggregation of bitwise XORs over a column expression. usage: | diff --git a/commands/docs/polars_math_cos.md b/commands/docs/polars_math_cos.md index b1658697362..556f406931e 100644 --- a/commands/docs/polars_math_cos.md +++ b/commands/docs/polars_math_cos.md @@ -2,7 +2,7 @@ title: polars math cos categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the element-wise cosine of a column expression. usage: | diff --git a/commands/docs/polars_math_dot.md b/commands/docs/polars_math_dot.md index 24e9b5dd56e..b322b2351f7 100644 --- a/commands/docs/polars_math_dot.md +++ b/commands/docs/polars_math_dot.md @@ -2,7 +2,7 @@ title: polars math dot categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the dot product of two column expressions. usage: | diff --git a/commands/docs/polars_math_exp.md b/commands/docs/polars_math_exp.md index 1d45dda65f0..82b45718fee 100644 --- a/commands/docs/polars_math_exp.md +++ b/commands/docs/polars_math_exp.md @@ -2,7 +2,7 @@ title: polars math exp categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute element-wise e raised to the power of a column expression. usage: | diff --git a/commands/docs/polars_math_log.md b/commands/docs/polars_math_log.md index 083b50dce66..2c8e6fad00a 100644 --- a/commands/docs/polars_math_log.md +++ b/commands/docs/polars_math_log.md @@ -2,7 +2,7 @@ title: polars math log categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the element-wise logarithm of a column expression. usage: | diff --git a/commands/docs/polars_math_log1p.md b/commands/docs/polars_math_log1p.md index 37c3345aab0..a7f8af797f4 100644 --- a/commands/docs/polars_math_log1p.md +++ b/commands/docs/polars_math_log1p.md @@ -2,7 +2,7 @@ title: polars math log1p categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the element-wise natural log of 1 + x for a column expression. usage: | diff --git a/commands/docs/polars_math_sign.md b/commands/docs/polars_math_sign.md index c8ef77fc517..1f021781e3e 100644 --- a/commands/docs/polars_math_sign.md +++ b/commands/docs/polars_math_sign.md @@ -2,7 +2,7 @@ title: polars math sign categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the element-wise sign of a column expression, returning -1, 0, or 1. usage: | diff --git a/commands/docs/polars_math_sin.md b/commands/docs/polars_math_sin.md index c146583f0c5..587b817640c 100644 --- a/commands/docs/polars_math_sin.md +++ b/commands/docs/polars_math_sin.md @@ -2,7 +2,7 @@ title: polars math sin categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the element-wise sine of a column expression. usage: | diff --git a/commands/docs/polars_math_sqrt.md b/commands/docs/polars_math_sqrt.md index 411b1db0ff4..555211ec206 100644 --- a/commands/docs/polars_math_sqrt.md +++ b/commands/docs/polars_math_sqrt.md @@ -2,7 +2,7 @@ title: polars math sqrt categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Compute the element-wise square root of a column expression. usage: | diff --git a/commands/docs/polars_max.md b/commands/docs/polars_max.md index 3230c949acf..6fa6d4d1e49 100644 --- a/commands/docs/polars_max.md +++ b/commands/docs/polars_max.md @@ -2,7 +2,7 @@ title: polars max categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a max expression or aggregates columns to their max value. usage: | diff --git a/commands/docs/polars_mean.md b/commands/docs/polars_mean.md index ee0b7da04c5..0a9d0ec7fdb 100644 --- a/commands/docs/polars_mean.md +++ b/commands/docs/polars_mean.md @@ -2,7 +2,7 @@ title: polars mean categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a mean expression for an aggregation or aggregates columns to their mean value. usage: | diff --git a/commands/docs/polars_median.md b/commands/docs/polars_median.md index 88d26348e26..9bbab17d621 100644 --- a/commands/docs/polars_median.md +++ b/commands/docs/polars_median.md @@ -2,7 +2,7 @@ title: polars median categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Median value from columns in a dataframe or creates expression for an aggregation usage: | diff --git a/commands/docs/polars_min.md b/commands/docs/polars_min.md index bf40755901e..bce166403c4 100644 --- a/commands/docs/polars_min.md +++ b/commands/docs/polars_min.md @@ -2,7 +2,7 @@ title: polars min categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a min expression or aggregates columns to their min value. usage: | diff --git a/commands/docs/polars_n-unique.md b/commands/docs/polars_n-unique.md index d47bb44576b..73884a3951a 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.115.1 +version: 0.116.0 dataframe: | Counts unique values. usage: | diff --git a/commands/docs/polars_not.md b/commands/docs/polars_not.md index 5fef81406ee..6073a272d16 100644 --- a/commands/docs/polars_not.md +++ b/commands/docs/polars_not.md @@ -2,7 +2,7 @@ title: polars not categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Inverts boolean mask. usage: | diff --git a/commands/docs/polars_open.md b/commands/docs/polars_open.md index 4c6f6e3cc07..11b31684ab7 100644 --- a/commands/docs/polars_open.md +++ b/commands/docs/polars_open.md @@ -2,7 +2,7 @@ title: polars open categories: | dataframe -version: 0.115.1 +version: 0.116.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 021be70e8db..840f2e6eaeb 100644 --- a/commands/docs/polars_otherwise.md +++ b/commands/docs/polars_otherwise.md @@ -2,7 +2,7 @@ title: polars otherwise categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Completes a when expression. usage: | diff --git a/commands/docs/polars_over.md b/commands/docs/polars_over.md index 693d6fde760..ed7937549b7 100644 --- a/commands/docs/polars_over.md +++ b/commands/docs/polars_over.md @@ -2,7 +2,7 @@ title: polars over categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Compute expressions over a window group defined by partition expressions. usage: | diff --git a/commands/docs/polars_pivot.md b/commands/docs/polars_pivot.md index 647ed28c1da..5277253c04d 100644 --- a/commands/docs/polars_pivot.md +++ b/commands/docs/polars_pivot.md @@ -2,7 +2,7 @@ title: polars pivot categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Pivot a DataFrame from long to wide format. usage: | diff --git a/commands/docs/polars_profile.md b/commands/docs/polars_profile.md index 03a62e9dca6..690a8cdb8f5 100644 --- a/commands/docs/polars_profile.md +++ b/commands/docs/polars_profile.md @@ -2,7 +2,7 @@ title: polars profile categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Profile a lazy dataframe. usage: | diff --git a/commands/docs/polars_qcut.md b/commands/docs/polars_qcut.md index fbe9f6a773f..38ea60fff8a 100644 --- a/commands/docs/polars_qcut.md +++ b/commands/docs/polars_qcut.md @@ -2,7 +2,7 @@ title: polars qcut categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Bin continuous values into discrete categories based on their quantiles for a series. usage: | diff --git a/commands/docs/polars_quantile.md b/commands/docs/polars_quantile.md index 69ed0173bc2..138b18e51bb 100644 --- a/commands/docs/polars_quantile.md +++ b/commands/docs/polars_quantile.md @@ -2,7 +2,7 @@ title: polars quantile categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Aggregates the columns to the selected quantile. usage: | diff --git a/commands/docs/polars_query.md b/commands/docs/polars_query.md index ee31d7c1b3f..d5d04b2778d 100644 --- a/commands/docs/polars_query.md +++ b/commands/docs/polars_query.md @@ -2,7 +2,7 @@ title: polars query categories: | dataframe -version: 0.115.1 +version: 0.116.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 efbe39ff28f..f2487217cab 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.115.1 +version: 0.116.0 dataframe_or_lazyframe: | Rename a dataframe column. usage: | diff --git a/commands/docs/polars_replace-time-zone.md b/commands/docs/polars_replace-time-zone.md index 0a4527acb8b..4df9b92fab1 100644 --- a/commands/docs/polars_replace-time-zone.md +++ b/commands/docs/polars_replace-time-zone.md @@ -2,7 +2,7 @@ title: polars replace-time-zone categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Replace the timezone information in a datetime column. usage: | diff --git a/commands/docs/polars_replace.md b/commands/docs/polars_replace.md index 5eb7277d27f..a13752c8b80 100644 --- a/commands/docs/polars_replace.md +++ b/commands/docs/polars_replace.md @@ -2,7 +2,7 @@ title: polars replace categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Create an expression that replaces old values with new values usage: | diff --git a/commands/docs/polars_reverse.md b/commands/docs/polars_reverse.md index 6c340df1425..de7e73ead33 100644 --- a/commands/docs/polars_reverse.md +++ b/commands/docs/polars_reverse.md @@ -2,7 +2,7 @@ title: polars reverse categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Reverses the LazyFrame usage: | diff --git a/commands/docs/polars_rolling.md b/commands/docs/polars_rolling.md index 18f55d0925c..859c4f1315f 100644 --- a/commands/docs/polars_rolling.md +++ b/commands/docs/polars_rolling.md @@ -2,7 +2,7 @@ title: polars rolling categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Rolling calculation for a series or expression, or a rolling group-by for a lazyframe. usage: | diff --git a/commands/docs/polars_sample.md b/commands/docs/polars_sample.md index 911e65703dc..0f91804b43e 100644 --- a/commands/docs/polars_sample.md +++ b/commands/docs/polars_sample.md @@ -2,7 +2,7 @@ title: polars sample categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Create sample dataframe. usage: | diff --git a/commands/docs/polars_save.md b/commands/docs/polars_save.md index b0528361f07..7d12baeb59e 100644 --- a/commands/docs/polars_save.md +++ b/commands/docs/polars_save.md @@ -2,7 +2,7 @@ title: polars save categories: | lazyframe -version: 0.115.1 +version: 0.116.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 5e08b400252..20f603becef 100644 --- a/commands/docs/polars_schema.md +++ b/commands/docs/polars_schema.md @@ -2,7 +2,7 @@ title: polars schema categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Show schema for a dataframe. usage: | diff --git a/commands/docs/polars_select.md b/commands/docs/polars_select.md index 44bd3666067..fad2277d812 100644 --- a/commands/docs/polars_select.md +++ b/commands/docs/polars_select.md @@ -2,7 +2,7 @@ title: polars select categories: | lazyframe -version: 0.115.1 +version: 0.116.0 lazyframe: | Selects columns from lazyframe. usage: | diff --git a/commands/docs/polars_selector.md b/commands/docs/polars_selector.md index bc55976f2d7..884f1255cb5 100644 --- a/commands/docs/polars_selector.md +++ b/commands/docs/polars_selector.md @@ -2,7 +2,7 @@ title: polars selector categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Create column selectors for use in polars commands. usage: | diff --git a/commands/docs/polars_selector_all.md b/commands/docs/polars_selector_all.md index c1dc111c285..0496e9fe029 100644 --- a/commands/docs/polars_selector_all.md +++ b/commands/docs/polars_selector_all.md @@ -2,7 +2,7 @@ title: polars selector all categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a selector that selects all columns. usage: | diff --git a/commands/docs/polars_selector_alpha.md b/commands/docs/polars_selector_alpha.md index 8f9d31b8d96..d89a87746a3 100644 --- a/commands/docs/polars_selector_alpha.md +++ b/commands/docs/polars_selector_alpha.md @@ -2,7 +2,7 @@ title: polars selector alpha categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all columns with alphabetic names (eg: only letters). Matching column names cannot contain *any* non-alphabetic characters. Note that the definition of "alphabetic" consists of all valid Unicode alphabetic characters by default; this can be changed by setting `--ascii-only`. usage: | diff --git a/commands/docs/polars_selector_alphanumeric.md b/commands/docs/polars_selector_alphanumeric.md index 78d0597fa85..a17f2ace2aa 100644 --- a/commands/docs/polars_selector_alphanumeric.md +++ b/commands/docs/polars_selector_alphanumeric.md @@ -2,7 +2,7 @@ title: polars selector alphanumeric categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all columns with alphanumeric names (eg: only letters). Matching column names cannot contain *any* non-alphanumeric characters. Note that the definition of "alphanumeric" consists of all valid Unicode alphanumeric characters by default; this can be changed by setting `ascii_only=true`. usage: | diff --git a/commands/docs/polars_selector_array.md b/commands/docs/polars_selector_array.md index cc298415032..1077cad4f2a 100644 --- a/commands/docs/polars_selector_array.md +++ b/commands/docs/polars_selector_array.md @@ -2,7 +2,7 @@ title: polars selector array categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all array columns. Optionally filter by fixed width. usage: | diff --git a/commands/docs/polars_selector_binary.md b/commands/docs/polars_selector_binary.md index a9f43638ef1..1d59dd818a0 100644 --- a/commands/docs/polars_selector_binary.md +++ b/commands/docs/polars_selector_binary.md @@ -2,7 +2,7 @@ title: polars selector binary categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all binary columns. usage: | diff --git a/commands/docs/polars_selector_boolean.md b/commands/docs/polars_selector_boolean.md index 2fa0869a46e..72b1e0b1cea 100644 --- a/commands/docs/polars_selector_boolean.md +++ b/commands/docs/polars_selector_boolean.md @@ -2,7 +2,7 @@ title: polars selector boolean categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all boolean columns. usage: | diff --git a/commands/docs/polars_selector_by-dtype.md b/commands/docs/polars_selector_by-dtype.md index 38a321966e6..9b51bf0da82 100644 --- a/commands/docs/polars_selector_by-dtype.md +++ b/commands/docs/polars_selector_by-dtype.md @@ -2,7 +2,7 @@ title: polars selector by-dtype categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a selector that selects columns by data type. usage: | diff --git a/commands/docs/polars_selector_by-index.md b/commands/docs/polars_selector_by-index.md index 0a48b805784..168573a7cb0 100644 --- a/commands/docs/polars_selector_by-index.md +++ b/commands/docs/polars_selector_by-index.md @@ -2,7 +2,7 @@ title: polars selector by-index categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select columns by their index position. Supports negative indices (e.g., -1 for the last column). usage: | diff --git a/commands/docs/polars_selector_by-name.md b/commands/docs/polars_selector_by-name.md index fe2078ce749..51d65412572 100644 --- a/commands/docs/polars_selector_by-name.md +++ b/commands/docs/polars_selector_by-name.md @@ -2,7 +2,7 @@ title: polars selector by-name categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a selector that selects columns by name. usage: | diff --git a/commands/docs/polars_selector_categorical.md b/commands/docs/polars_selector_categorical.md index daf9e77fe3a..e587e5ea537 100644 --- a/commands/docs/polars_selector_categorical.md +++ b/commands/docs/polars_selector_categorical.md @@ -2,7 +2,7 @@ title: polars selector categorical categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all categorical columns. usage: | diff --git a/commands/docs/polars_selector_contains.md b/commands/docs/polars_selector_contains.md index fab120fe874..db932c282b8 100644 --- a/commands/docs/polars_selector_contains.md +++ b/commands/docs/polars_selector_contains.md @@ -2,7 +2,7 @@ title: polars selector contains categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select columns whose names contain the given literal substring(s). usage: | diff --git a/commands/docs/polars_selector_date.md b/commands/docs/polars_selector_date.md index 8394993ef40..1bf22992f89 100644 --- a/commands/docs/polars_selector_date.md +++ b/commands/docs/polars_selector_date.md @@ -2,7 +2,7 @@ title: polars selector date categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all date columns. usage: | diff --git a/commands/docs/polars_selector_datetime.md b/commands/docs/polars_selector_datetime.md index a088d8af97e..c7f001bc920 100644 --- a/commands/docs/polars_selector_datetime.md +++ b/commands/docs/polars_selector_datetime.md @@ -2,7 +2,7 @@ title: polars selector datetime categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all datetime columns. Optionally filter by time unit (ns, us, ms) and/or timezone. usage: | diff --git a/commands/docs/polars_selector_decimal.md b/commands/docs/polars_selector_decimal.md index cd5915981c5..3d8eb1ab5f2 100644 --- a/commands/docs/polars_selector_decimal.md +++ b/commands/docs/polars_selector_decimal.md @@ -2,7 +2,7 @@ title: polars selector decimal categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all decimal columns. usage: | diff --git a/commands/docs/polars_selector_digit.md b/commands/docs/polars_selector_digit.md index 30e68029a65..94f478559de 100644 --- a/commands/docs/polars_selector_digit.md +++ b/commands/docs/polars_selector_digit.md @@ -2,7 +2,7 @@ title: polars selector digit categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select columns whose names consist entirely of digit characters. By default uses Unicode decimal digits; use `--ascii-only` to restrict to ASCII 0-9. usage: | diff --git a/commands/docs/polars_selector_duration.md b/commands/docs/polars_selector_duration.md index 6842fe086b2..cce3bab5a22 100644 --- a/commands/docs/polars_selector_duration.md +++ b/commands/docs/polars_selector_duration.md @@ -2,7 +2,7 @@ title: polars selector duration categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all duration columns. Optionally filter by time unit (ns, us, ms). usage: | diff --git a/commands/docs/polars_selector_empty.md b/commands/docs/polars_selector_empty.md index 5778bb842c5..4b64b037169 100644 --- a/commands/docs/polars_selector_empty.md +++ b/commands/docs/polars_selector_empty.md @@ -2,7 +2,7 @@ title: polars selector empty categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Create an empty selector that matches no columns. Useful as a base for selector composition. usage: | diff --git a/commands/docs/polars_selector_ends-with.md b/commands/docs/polars_selector_ends-with.md index af8357b3a8a..c7824f7e51b 100644 --- a/commands/docs/polars_selector_ends-with.md +++ b/commands/docs/polars_selector_ends-with.md @@ -2,7 +2,7 @@ title: polars selector ends-with categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select columns that end with the given substring(s). usage: | diff --git a/commands/docs/polars_selector_enum.md b/commands/docs/polars_selector_enum.md index c24941b0d90..04c7dfdbcad 100644 --- a/commands/docs/polars_selector_enum.md +++ b/commands/docs/polars_selector_enum.md @@ -2,7 +2,7 @@ title: polars selector enum categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all enum columns. usage: | diff --git a/commands/docs/polars_selector_exclude.md b/commands/docs/polars_selector_exclude.md index 85bef2e428a..1b9c46fe873 100644 --- a/commands/docs/polars_selector_exclude.md +++ b/commands/docs/polars_selector_exclude.md @@ -2,7 +2,7 @@ title: polars selector exclude categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all columns except those with the given name(s). This is the inverse of `polars selector by-name`. usage: | diff --git a/commands/docs/polars_selector_first.md b/commands/docs/polars_selector_first.md index 6f11b59a933..186b39b8e0e 100644 --- a/commands/docs/polars_selector_first.md +++ b/commands/docs/polars_selector_first.md @@ -2,7 +2,7 @@ title: polars selector first categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a selector that selects the first column(s) by index. usage: | diff --git a/commands/docs/polars_selector_float.md b/commands/docs/polars_selector_float.md index f4b8a86bd29..0fe7af1200f 100644 --- a/commands/docs/polars_selector_float.md +++ b/commands/docs/polars_selector_float.md @@ -2,7 +2,7 @@ title: polars selector float categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all float columns. usage: | diff --git a/commands/docs/polars_selector_integer.md b/commands/docs/polars_selector_integer.md index c2ddf5e60c8..27da3334708 100644 --- a/commands/docs/polars_selector_integer.md +++ b/commands/docs/polars_selector_integer.md @@ -2,7 +2,7 @@ title: polars selector integer categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all integer columns. usage: | diff --git a/commands/docs/polars_selector_last.md b/commands/docs/polars_selector_last.md index 03e17c67519..4447faf8635 100644 --- a/commands/docs/polars_selector_last.md +++ b/commands/docs/polars_selector_last.md @@ -2,7 +2,7 @@ title: polars selector last categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Creates a selector that selects the last column(s) by index. usage: | diff --git a/commands/docs/polars_selector_list.md b/commands/docs/polars_selector_list.md index 11ec0846bf5..d0538e1ee10 100644 --- a/commands/docs/polars_selector_list.md +++ b/commands/docs/polars_selector_list.md @@ -2,7 +2,7 @@ title: polars selector list categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all list columns. usage: | diff --git a/commands/docs/polars_selector_matches.md b/commands/docs/polars_selector_matches.md index 44d97811537..cd09ec27d72 100644 --- a/commands/docs/polars_selector_matches.md +++ b/commands/docs/polars_selector_matches.md @@ -2,7 +2,7 @@ title: polars selector matches categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all columns that match the given regex pattern. usage: | diff --git a/commands/docs/polars_selector_nested.md b/commands/docs/polars_selector_nested.md index 9d2ae0960db..6f62f84656e 100644 --- a/commands/docs/polars_selector_nested.md +++ b/commands/docs/polars_selector_nested.md @@ -2,7 +2,7 @@ title: polars selector nested categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all nested columns (list, array, or struct). usage: | diff --git a/commands/docs/polars_selector_not.md b/commands/docs/polars_selector_not.md index 0655d031542..19fb95bc076 100644 --- a/commands/docs/polars_selector_not.md +++ b/commands/docs/polars_selector_not.md @@ -2,7 +2,7 @@ title: polars selector not categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Inverts selector. usage: | diff --git a/commands/docs/polars_selector_numeric.md b/commands/docs/polars_selector_numeric.md index b509cc9d980..53c907162ab 100644 --- a/commands/docs/polars_selector_numeric.md +++ b/commands/docs/polars_selector_numeric.md @@ -2,7 +2,7 @@ title: polars selector numeric categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all numeric columns. usage: | diff --git a/commands/docs/polars_selector_object.md b/commands/docs/polars_selector_object.md index beefe487066..179abccaa30 100644 --- a/commands/docs/polars_selector_object.md +++ b/commands/docs/polars_selector_object.md @@ -2,7 +2,7 @@ title: polars selector object categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all object columns. usage: | diff --git a/commands/docs/polars_selector_signed-integer.md b/commands/docs/polars_selector_signed-integer.md index 407a48df1c0..61b468b909e 100644 --- a/commands/docs/polars_selector_signed-integer.md +++ b/commands/docs/polars_selector_signed-integer.md @@ -2,7 +2,7 @@ title: polars selector signed-integer categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all signed integer columns. usage: | diff --git a/commands/docs/polars_selector_starts-with.md b/commands/docs/polars_selector_starts-with.md index 7caae4e72b8..87bcaf3c8d6 100644 --- a/commands/docs/polars_selector_starts-with.md +++ b/commands/docs/polars_selector_starts-with.md @@ -2,7 +2,7 @@ title: polars selector starts-with categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select columns that start with the given substring(s). usage: | diff --git a/commands/docs/polars_selector_string.md b/commands/docs/polars_selector_string.md index 273a06067ef..83479d21b8d 100644 --- a/commands/docs/polars_selector_string.md +++ b/commands/docs/polars_selector_string.md @@ -2,7 +2,7 @@ title: polars selector string categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all string columns. Use `--include-categorical` to also select categorical columns. usage: | diff --git a/commands/docs/polars_selector_struct.md b/commands/docs/polars_selector_struct.md index 1f3a29506ab..481a3e19c31 100644 --- a/commands/docs/polars_selector_struct.md +++ b/commands/docs/polars_selector_struct.md @@ -2,7 +2,7 @@ title: polars selector struct categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all struct columns. usage: | diff --git a/commands/docs/polars_selector_temporal.md b/commands/docs/polars_selector_temporal.md index 540c4ef53e5..5d18534b68b 100644 --- a/commands/docs/polars_selector_temporal.md +++ b/commands/docs/polars_selector_temporal.md @@ -2,7 +2,7 @@ title: polars selector temporal categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all temporal columns (date, datetime, duration, and time). usage: | diff --git a/commands/docs/polars_selector_unsigned-integer.md b/commands/docs/polars_selector_unsigned-integer.md index 028d6626214..55d1202c9c3 100644 --- a/commands/docs/polars_selector_unsigned-integer.md +++ b/commands/docs/polars_selector_unsigned-integer.md @@ -2,7 +2,7 @@ title: polars selector unsigned-integer categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Select all unsigned integer columns. usage: | diff --git a/commands/docs/polars_set-with-idx.md b/commands/docs/polars_set-with-idx.md index da7c3f0b861..17e379522e7 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.115.1 +version: 0.116.0 dataframe: | Sets value in the given index. usage: | diff --git a/commands/docs/polars_set.md b/commands/docs/polars_set.md index f72bde5849e..708088933b2 100644 --- a/commands/docs/polars_set.md +++ b/commands/docs/polars_set.md @@ -2,7 +2,7 @@ title: polars set categories: | dataframe -version: 0.115.1 +version: 0.116.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 be387349bf0..e0756d062ed 100644 --- a/commands/docs/polars_shape.md +++ b/commands/docs/polars_shape.md @@ -2,7 +2,7 @@ title: polars shape categories: | dataframe -version: 0.115.1 +version: 0.116.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 24cb52a96ba..fbd6736ef22 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.115.1 +version: 0.116.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 18b071e3dac..2c49e044289 100644 --- a/commands/docs/polars_slice.md +++ b/commands/docs/polars_slice.md @@ -2,7 +2,7 @@ title: polars slice categories: | dataframe -version: 0.115.1 +version: 0.116.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 846cef555e3..9ce4694b22f 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.115.1 +version: 0.116.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 419a4b8bdce..be20735f3aa 100644 --- a/commands/docs/polars_std.md +++ b/commands/docs/polars_std.md @@ -2,7 +2,7 @@ title: polars std categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a std expression for an aggregation of std value from columns in a dataframe. usage: | diff --git a/commands/docs/polars_store-get.md b/commands/docs/polars_store-get.md index 0f1777a9460..d776296c5bf 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.115.1 +version: 0.116.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 d8611217f5c..bcbd9f31f1b 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.115.1 +version: 0.116.0 dataframe: | Lists stored polars objects. usage: | diff --git a/commands/docs/polars_store-rm.md b/commands/docs/polars_store-rm.md index f666fddd487..71f76c450bd 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.115.1 +version: 0.116.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 index 4bffd5d8d31..ec5634c86c6 100644 --- a/commands/docs/polars_str-join.md +++ b/commands/docs/polars_str-join.md @@ -2,7 +2,7 @@ title: polars str-join categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Concatenates strings within a column or dataframes usage: | diff --git a/commands/docs/polars_str-lengths.md b/commands/docs/polars_str-lengths.md index 99da0342921..85035f41ca7 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.115.1 +version: 0.116.0 dataframe: | Get lengths of all strings. usage: | diff --git a/commands/docs/polars_str-replace-all.md b/commands/docs/polars_str-replace-all.md index bc2d2548d52..534beb22b91 100644 --- a/commands/docs/polars_str-replace-all.md +++ b/commands/docs/polars_str-replace-all.md @@ -2,7 +2,7 @@ title: polars str-replace-all categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Replace all (sub)strings by a regex pattern. usage: | diff --git a/commands/docs/polars_str-replace.md b/commands/docs/polars_str-replace.md index 11800d6287f..cd0535a6e2a 100644 --- a/commands/docs/polars_str-replace.md +++ b/commands/docs/polars_str-replace.md @@ -2,7 +2,7 @@ title: polars str-replace categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Replace the leftmost (sub)string by a regex pattern. usage: | diff --git a/commands/docs/polars_str-slice.md b/commands/docs/polars_str-slice.md index fa26d8e41cd..2b083ef747e 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.115.1 +version: 0.116.0 dataframe: | Slices the string from the start position until the selected length. usage: | diff --git a/commands/docs/polars_str-split.md b/commands/docs/polars_str-split.md index dedda4b7352..bec3d421fa6 100644 --- a/commands/docs/polars_str-split.md +++ b/commands/docs/polars_str-split.md @@ -2,7 +2,7 @@ title: polars str-split categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Split the string by a substring. The resulting dtype is list. usage: | diff --git a/commands/docs/polars_str-strip-chars.md b/commands/docs/polars_str-strip-chars.md index b303e244a4b..42c260c5134 100644 --- a/commands/docs/polars_str-strip-chars.md +++ b/commands/docs/polars_str-strip-chars.md @@ -2,7 +2,7 @@ title: polars str-strip-chars categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Strips specified characters from strings in a column usage: | diff --git a/commands/docs/polars_strftime.md b/commands/docs/polars_strftime.md index 0c9ac26c97f..ac50c13ee0e 100644 --- a/commands/docs/polars_strftime.md +++ b/commands/docs/polars_strftime.md @@ -2,7 +2,7 @@ title: polars strftime categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Formats date based on string rule. usage: | diff --git a/commands/docs/polars_struct-json-encode.md b/commands/docs/polars_struct-json-encode.md index 60e3df057a4..185413df5d0 100644 --- a/commands/docs/polars_struct-json-encode.md +++ b/commands/docs/polars_struct-json-encode.md @@ -2,7 +2,7 @@ title: polars struct-json-encode categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Convert this struct to a string column with json values. usage: | diff --git a/commands/docs/polars_sum.md b/commands/docs/polars_sum.md index ce63c6487db..f30bd57a6a7 100644 --- a/commands/docs/polars_sum.md +++ b/commands/docs/polars_sum.md @@ -2,7 +2,7 @@ title: polars sum categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates a sum expression for an aggregation or aggregates columns to their sum value. usage: | diff --git a/commands/docs/polars_summary.md b/commands/docs/polars_summary.md index 471b39df328..14e4f2527f3 100644 --- a/commands/docs/polars_summary.md +++ b/commands/docs/polars_summary.md @@ -2,7 +2,7 @@ title: polars summary categories: | dataframe -version: 0.115.1 +version: 0.116.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 8a0f7c8e75e..783a803a627 100644 --- a/commands/docs/polars_take.md +++ b/commands/docs/polars_take.md @@ -2,7 +2,7 @@ title: polars take categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Creates new dataframe using the given indices. usage: | diff --git a/commands/docs/polars_truncate.md b/commands/docs/polars_truncate.md index a20342967de..70694c50525 100644 --- a/commands/docs/polars_truncate.md +++ b/commands/docs/polars_truncate.md @@ -2,7 +2,7 @@ title: polars truncate categories: | expression -version: 0.115.1 +version: 0.116.0 expression: | Divide the date/datetime range into buckets. usage: | @@ -52,7 +52,7 @@ Truncate a series of dates by period length ├───┼─────────────┼─────────────┤ │ 0 │ 2 years ago │ 2 years ago │ │ 1 │ 2 years ago │ 2 years ago │ -│ 2 │ a year ago │ a year ago │ +│ 2 │ 2 years ago │ 2 years ago │ │ 3 │ a year ago │ a year ago │ ╰───┴─────────────┴─────────────╯ diff --git a/commands/docs/polars_unique.md b/commands/docs/polars_unique.md index a45aeb7d910..970d2e4d3a1 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.115.1 +version: 0.116.0 dataframe_or_lazyframe: | Returns unique values from a dataframe. usage: | diff --git a/commands/docs/polars_unnest.md b/commands/docs/polars_unnest.md index 11337192910..0493b417dbf 100644 --- a/commands/docs/polars_unnest.md +++ b/commands/docs/polars_unnest.md @@ -2,7 +2,7 @@ title: polars unnest categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Decompose struct columns into separate columns for each of their fields. The new columns will be inserted into the dataframe at the location of the struct column. usage: | diff --git a/commands/docs/polars_unpivot.md b/commands/docs/polars_unpivot.md index e185345272b..917563ab5ad 100644 --- a/commands/docs/polars_unpivot.md +++ b/commands/docs/polars_unpivot.md @@ -2,7 +2,7 @@ title: polars unpivot categories: | dataframe -version: 0.115.1 +version: 0.116.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 b48ddf7eb6a..042b8f5b3d0 100644 --- a/commands/docs/polars_uppercase.md +++ b/commands/docs/polars_uppercase.md @@ -2,7 +2,7 @@ title: polars uppercase categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Uppercase the strings in the column. usage: | diff --git a/commands/docs/polars_value-counts.md b/commands/docs/polars_value-counts.md index 5bc869f36dc..9d5171fde17 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.115.1 +version: 0.116.0 dataframe: | Returns a dataframe with the counts for unique values in series. usage: | diff --git a/commands/docs/polars_var.md b/commands/docs/polars_var.md index ad7d1928b5d..70c3c1eb309 100644 --- a/commands/docs/polars_var.md +++ b/commands/docs/polars_var.md @@ -2,7 +2,7 @@ title: polars var categories: | dataframe -version: 0.115.1 +version: 0.116.0 dataframe: | Create a var expression for an aggregation. usage: | diff --git a/commands/docs/polars_when.md b/commands/docs/polars_when.md index 47664a572e3..ac6f60cf294 100644 --- a/commands/docs/polars_when.md +++ b/commands/docs/polars_when.md @@ -2,7 +2,7 @@ title: polars when categories: | expression -version: 0.115.1 +version: 0.116.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 c6c615f7097..f5d9d2f444d 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.115.1 +version: 0.116.0 dataframe_or_lazyframe: | Adds a series to the dataframe. usage: | diff --git a/commands/docs/port.md b/commands/docs/port.md index 1420a15a608..479e4dce861 100644 --- a/commands/docs/port.md +++ b/commands/docs/port.md @@ -2,7 +2,7 @@ title: port categories: | network -version: 0.115.1 +version: 0.116.0 network: | Get a free TCP port from system. usage: | diff --git a/commands/docs/prepend.md b/commands/docs/prepend.md index 3f8c68c7a62..f67cb858b2c 100644 --- a/commands/docs/prepend.md +++ b/commands/docs/prepend.md @@ -2,7 +2,7 @@ title: prepend categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Prepend any number of rows to a table. usage: | diff --git a/commands/docs/print.md b/commands/docs/print.md index 704cdd90eb6..5448d6b6810 100644 --- a/commands/docs/print.md +++ b/commands/docs/print.md @@ -2,7 +2,7 @@ title: print categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Print the given values to stdout. usage: | diff --git a/commands/docs/ps.md b/commands/docs/ps.md index 7c308d3d3a2..a6cabaefb07 100644 --- a/commands/docs/ps.md +++ b/commands/docs/ps.md @@ -2,7 +2,7 @@ title: ps categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about system processes. usage: | diff --git a/commands/docs/pwd.md b/commands/docs/pwd.md index 16e7a8afcaf..a30b81afad2 100644 --- a/commands/docs/pwd.md +++ b/commands/docs/pwd.md @@ -2,7 +2,7 @@ title: pwd categories: | default -version: 0.115.1 +version: 0.116.0 default: | Return the current working directory usage: | diff --git a/commands/docs/query.md b/commands/docs/query.md index 4b86382f5b9..53534e4cc6b 100644 --- a/commands/docs/query.md +++ b/commands/docs/query.md @@ -2,7 +2,7 @@ title: query categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Show all the query commands usage: | diff --git a/commands/docs/query_db.md b/commands/docs/query_db.md index 432844e111b..99fdad6d7a5 100644 --- a/commands/docs/query_db.md +++ b/commands/docs/query_db.md @@ -2,7 +2,7 @@ title: query db categories: | database -version: 0.115.1 +version: 0.116.0 database: | Query a SQLite database with SQL statements. usage: | diff --git a/commands/docs/query_json.md b/commands/docs/query_json.md index 2fdec42c4dd..9ffa126a00b 100644 --- a/commands/docs/query_json.md +++ b/commands/docs/query_json.md @@ -2,7 +2,7 @@ title: query json categories: | filters -version: 0.115.1 +version: 0.116.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 913d2f98e3a..e03b427d3ea 100644 --- a/commands/docs/query_web.md +++ b/commands/docs/query_web.md @@ -2,7 +2,7 @@ title: query web categories: | network -version: 0.115.1 +version: 0.116.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 c1b70283e6d..64ba5de71c7 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.115.1 +version: 0.116.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 d618aef3c15..1eb386c8ea4 100644 --- a/commands/docs/query_xml.md +++ b/commands/docs/query_xml.md @@ -2,7 +2,7 @@ title: query xml categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Execute XPath 1.0 query on XML input usage: | diff --git a/commands/docs/random.md b/commands/docs/random.md index 884af7cce26..0359df62e2b 100644 --- a/commands/docs/random.md +++ b/commands/docs/random.md @@ -2,7 +2,7 @@ title: random categories: | random -version: 0.115.1 +version: 0.116.0 random: | Generate a random value. usage: | diff --git a/commands/docs/random_binary.md b/commands/docs/random_binary.md index 9a8ddaee211..6e3b1c6f992 100644 --- a/commands/docs/random_binary.md +++ b/commands/docs/random_binary.md @@ -2,7 +2,7 @@ title: random binary categories: | random -version: 0.115.1 +version: 0.116.0 random: | Generate random bytes. usage: | diff --git a/commands/docs/random_bool.md b/commands/docs/random_bool.md index 12239427895..312b321177e 100644 --- a/commands/docs/random_bool.md +++ b/commands/docs/random_bool.md @@ -2,7 +2,7 @@ title: random bool categories: | random -version: 0.115.1 +version: 0.116.0 random: | Generate a random boolean value. usage: | diff --git a/commands/docs/random_chars.md b/commands/docs/random_chars.md index bba030ab7d7..05fb718de10 100644 --- a/commands/docs/random_chars.md +++ b/commands/docs/random_chars.md @@ -2,7 +2,7 @@ title: random chars categories: | random -version: 0.115.1 +version: 0.116.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_float.md b/commands/docs/random_float.md index d487a3daf38..088326a598e 100644 --- a/commands/docs/random_float.md +++ b/commands/docs/random_float.md @@ -2,7 +2,7 @@ title: random float categories: | random -version: 0.115.1 +version: 0.116.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 f52f56b0cf4..b2cd2b15aa5 100644 --- a/commands/docs/random_int.md +++ b/commands/docs/random_int.md @@ -2,7 +2,7 @@ title: random int categories: | random -version: 0.115.1 +version: 0.116.0 random: | Generate a random integer [min..max]. usage: | diff --git a/commands/docs/random_pass.md b/commands/docs/random_pass.md index 8c7dfbab5a0..510ee111804 100644 --- a/commands/docs/random_pass.md +++ b/commands/docs/random_pass.md @@ -2,7 +2,7 @@ title: random pass categories: | random -version: 0.115.1 +version: 0.116.0 random: | Generate a cryptologically secure password. usage: | diff --git a/commands/docs/random_uuid.md b/commands/docs/random_uuid.md index 71169473b83..cc8bf78fd6d 100644 --- a/commands/docs/random_uuid.md +++ b/commands/docs/random_uuid.md @@ -2,7 +2,7 @@ title: random uuid categories: | random -version: 0.115.1 +version: 0.116.0 random: | Generate a random uuid string of the specified version. usage: | diff --git a/commands/docs/reduce.md b/commands/docs/reduce.md index 0d33e92f30c..24e59fe4717 100644 --- a/commands/docs/reduce.md +++ b/commands/docs/reduce.md @@ -2,7 +2,7 @@ title: reduce categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Aggregate a list (starting from the left) to a single value using an accumulator closure. usage: | diff --git a/commands/docs/registry.md b/commands/docs/registry.md index 84760d572ab..52947f06328 100644 --- a/commands/docs/registry.md +++ b/commands/docs/registry.md @@ -2,7 +2,7 @@ title: registry categories: | system -version: 0.115.1 +version: 0.116.0 system: | Various commands for interacting with the system registry (Windows only). usage: | diff --git a/commands/docs/registry_query.md b/commands/docs/registry_query.md index 38c87f5d02e..473ad0c2d67 100644 --- a/commands/docs/registry_query.md +++ b/commands/docs/registry_query.md @@ -2,7 +2,7 @@ title: registry query categories: | system -version: 0.115.1 +version: 0.116.0 system: | Query the Windows registry. usage: | diff --git a/commands/docs/reject.md b/commands/docs/reject.md index 8b082fa52bd..41cdd28ab65 100644 --- a/commands/docs/reject.md +++ b/commands/docs/reject.md @@ -2,7 +2,7 @@ title: reject categories: | filters -version: 0.115.1 +version: 0.116.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 6980e152b17..8ba8d62635a 100644 --- a/commands/docs/rename.md +++ b/commands/docs/rename.md @@ -2,7 +2,7 @@ title: rename categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Creates a new table with columns renamed. usage: | diff --git a/commands/docs/return.md b/commands/docs/return.md index 5510e25bc99..049dfb23519 100644 --- a/commands/docs/return.md +++ b/commands/docs/return.md @@ -2,7 +2,7 @@ title: return categories: | core -version: 0.115.1 +version: 0.116.0 core: | Return early from a custom command. usage: | diff --git a/commands/docs/reverse.md b/commands/docs/reverse.md index 23bd8e5c3e1..ee0c6580085 100644 --- a/commands/docs/reverse.md +++ b/commands/docs/reverse.md @@ -2,7 +2,7 @@ title: reverse categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Reverses the input list or table. usage: | diff --git a/commands/docs/rm.md b/commands/docs/rm.md index c58673d53f1..f43739ce741 100644 --- a/commands/docs/rm.md +++ b/commands/docs/rm.md @@ -2,7 +2,7 @@ title: rm categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Remove files and directories. usage: | diff --git a/commands/docs/roll.md b/commands/docs/roll.md index 05860013bdd..76b079fb4c3 100644 --- a/commands/docs/roll.md +++ b/commands/docs/roll.md @@ -2,7 +2,7 @@ title: roll categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Rolling commands for tables. usage: | diff --git a/commands/docs/roll_down.md b/commands/docs/roll_down.md index b0cf0a744f0..0a7074e85e4 100644 --- a/commands/docs/roll_down.md +++ b/commands/docs/roll_down.md @@ -2,7 +2,7 @@ title: roll down categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Roll table rows down. usage: | diff --git a/commands/docs/roll_left.md b/commands/docs/roll_left.md index 25b92447b65..0eb14b1f2f7 100644 --- a/commands/docs/roll_left.md +++ b/commands/docs/roll_left.md @@ -2,7 +2,7 @@ title: roll left categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Roll record or table columns left. usage: | diff --git a/commands/docs/roll_right.md b/commands/docs/roll_right.md index 66ab5a113cc..405104b7a92 100644 --- a/commands/docs/roll_right.md +++ b/commands/docs/roll_right.md @@ -2,7 +2,7 @@ title: roll right categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Roll table columns right. usage: | diff --git a/commands/docs/roll_up.md b/commands/docs/roll_up.md index 8146595a116..9a08e33edf4 100644 --- a/commands/docs/roll_up.md +++ b/commands/docs/roll_up.md @@ -2,7 +2,7 @@ title: roll up categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Roll table rows up. usage: | diff --git a/commands/docs/rotate.md b/commands/docs/rotate.md index c0e611f75d1..8d86f4ba7a7 100644 --- a/commands/docs/rotate.md +++ b/commands/docs/rotate.md @@ -2,7 +2,7 @@ title: rotate categories: | filters -version: 0.115.1 +version: 0.116.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 6eb58a3d780..d183d301220 100644 --- a/commands/docs/run-external.md +++ b/commands/docs/run-external.md @@ -2,7 +2,7 @@ title: run-external categories: | system -version: 0.115.1 +version: 0.116.0 system: | Runs external command. usage: | diff --git a/commands/docs/run-internal.md b/commands/docs/run-internal.md index 10816680207..fec5db334c3 100644 --- a/commands/docs/run-internal.md +++ b/commands/docs/run-internal.md @@ -2,7 +2,7 @@ title: run-internal categories: | default -version: 0.115.1 +version: 0.116.0 default: | Run a built-in command by name. Used internally by `%($cmd)` dynamic dispatch. usage: | diff --git a/commands/docs/run.md b/commands/docs/run.md index 7feb31e0a0e..8460eb7ac0c 100644 --- a/commands/docs/run.md +++ b/commands/docs/run.md @@ -2,7 +2,7 @@ title: run categories: | core -version: 0.115.1 +version: 0.116.0 core: | Runs a script file in an isolated scope as part of a pipeline. usage: | diff --git a/commands/docs/save.md b/commands/docs/save.md index f94ce78cac5..e178c9e7d69 100644 --- a/commands/docs/save.md +++ b/commands/docs/save.md @@ -2,7 +2,7 @@ title: save categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Save a file. usage: | @@ -29,7 +29,7 @@ contributors: false - `--stderr, -e {path}`: The filename used to save stderr, only works with `-r` flag. - `--raw, -r`: Save file as raw binary. - `--append, -a`: Append input to the end of the file. - - `--force, -f`: Overwrite the destination. + - `--force, -f`: Overwrite the destination, creating missing parent directories. - `--progress, -p`: Enable progress bar. ## Parameters diff --git a/commands/docs/schema.md b/commands/docs/schema.md index 88a9e7d5858..5157d696880 100644 --- a/commands/docs/schema.md +++ b/commands/docs/schema.md @@ -2,7 +2,7 @@ title: schema categories: | database -version: 0.115.1 +version: 0.116.0 database: | Show the schema of a SQLite database. usage: | diff --git a/commands/docs/scope.md b/commands/docs/scope.md index 173d344d66c..acfca2b65e5 100644 --- a/commands/docs/scope.md +++ b/commands/docs/scope.md @@ -2,7 +2,7 @@ title: scope categories: | core -version: 0.115.1 +version: 0.116.0 core: | Commands for getting info about what is in scope. usage: | diff --git a/commands/docs/scope_aliases.md b/commands/docs/scope_aliases.md index 79068d07188..8efcedc0abe 100644 --- a/commands/docs/scope_aliases.md +++ b/commands/docs/scope_aliases.md @@ -2,7 +2,7 @@ title: scope aliases categories: | core -version: 0.115.1 +version: 0.116.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 b6060aa78e5..8d30e13f3a9 100644 --- a/commands/docs/scope_commands.md +++ b/commands/docs/scope_commands.md @@ -2,7 +2,7 @@ title: scope commands categories: | core -version: 0.115.1 +version: 0.116.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 6a8a3bf98fd..67b82a4df2b 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.115.1 +version: 0.116.0 core: | Output stats on the engine in the current state, including interactive last-result size info. usage: | diff --git a/commands/docs/scope_externs.md b/commands/docs/scope_externs.md index 8b8f13d735d..488989cfdf6 100644 --- a/commands/docs/scope_externs.md +++ b/commands/docs/scope_externs.md @@ -2,7 +2,7 @@ title: scope externs categories: | core -version: 0.115.1 +version: 0.116.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 a61bdc92929..4ea731c0a91 100644 --- a/commands/docs/scope_modules.md +++ b/commands/docs/scope_modules.md @@ -2,7 +2,7 @@ title: scope modules categories: | core -version: 0.115.1 +version: 0.116.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 b6040f7568a..4be6e8dad6b 100644 --- a/commands/docs/scope_variables.md +++ b/commands/docs/scope_variables.md @@ -2,7 +2,7 @@ title: scope variables categories: | core -version: 0.115.1 +version: 0.116.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 7f4f451624e..4de103c1643 100644 --- a/commands/docs/select.md +++ b/commands/docs/select.md @@ -2,7 +2,7 @@ title: select categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Select only these columns or rows from the input. Opposite of `reject`. usage: | diff --git a/commands/docs/semver.md b/commands/docs/semver.md index 0cb9810b40c..eadae21574d 100644 --- a/commands/docs/semver.md +++ b/commands/docs/semver.md @@ -2,7 +2,7 @@ title: semver categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Various commands for working with semantic versions. usage: | diff --git a/commands/docs/semver_bump.md b/commands/docs/semver_bump.md index 7d79296fd22..329776294bf 100644 --- a/commands/docs/semver_bump.md +++ b/commands/docs/semver_bump.md @@ -2,7 +2,7 @@ title: semver bump categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Bump a semantic version to the next level. usage: | diff --git a/commands/docs/seq.md b/commands/docs/seq.md index 24d7d02d5f7..4ba312748c9 100644 --- a/commands/docs/seq.md +++ b/commands/docs/seq.md @@ -2,7 +2,7 @@ title: seq categories: | generators -version: 0.115.1 +version: 0.116.0 generators: | Output sequences of numbers. usage: | diff --git a/commands/docs/seq_char.md b/commands/docs/seq_char.md index 4ac7a4fe3bc..be669cbeb1f 100644 --- a/commands/docs/seq_char.md +++ b/commands/docs/seq_char.md @@ -2,7 +2,7 @@ title: seq char categories: | generators -version: 0.115.1 +version: 0.116.0 generators: | Print a sequence of ASCII characters. usage: | diff --git a/commands/docs/seq_date.md b/commands/docs/seq_date.md index 9d12d196f9a..6b82057d276 100644 --- a/commands/docs/seq_date.md +++ b/commands/docs/seq_date.md @@ -2,7 +2,7 @@ title: seq date categories: | generators -version: 0.115.1 +version: 0.116.0 generators: | Print sequences of dates. usage: | diff --git a/commands/docs/shuffle.md b/commands/docs/shuffle.md index 864189a9e2b..9ea6e2d564c 100644 --- a/commands/docs/shuffle.md +++ b/commands/docs/shuffle.md @@ -2,7 +2,7 @@ title: shuffle categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Shuffle rows randomly. usage: | diff --git a/commands/docs/skip.md b/commands/docs/skip.md index d86ce0d94fa..b94063cd565 100644 --- a/commands/docs/skip.md +++ b/commands/docs/skip.md @@ -2,7 +2,7 @@ title: skip categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Skip the first several rows of the input. Counterpart of `drop`. Opposite of `first`. For binary input, n can also be specified as a filesize. usage: | diff --git a/commands/docs/skip_until.md b/commands/docs/skip_until.md index 9cefd001d9e..c40a03f541f 100644 --- a/commands/docs/skip_until.md +++ b/commands/docs/skip_until.md @@ -2,7 +2,7 @@ title: skip until categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Skip elements of the input until a predicate is true. usage: | @@ -39,7 +39,7 @@ contributors: false Skip until the element is positive. ```nu -> [-2 0 2 -1] | skip until {|x| $x > 0 } +> [-2 0 2 -1] | skip until $it > 0 ╭───┬────╮ │ 0 │ 2 │ │ 1 │ -1 │ @@ -59,7 +59,7 @@ Skip until the element is positive using stored condition. Skip until the field value is positive. ```nu -> [{a: -2} {a: 0} {a: 2} {a: -1}] | skip until {|x| $x.a > 0 } +> [{a: -2} {a: 0} {a: 2} {a: -1}] | skip until a > 0 ╭───┬────╮ │ # │ a │ ├───┼────┤ diff --git a/commands/docs/skip_while.md b/commands/docs/skip_while.md index 7030c051277..10ebb24ff6c 100644 --- a/commands/docs/skip_while.md +++ b/commands/docs/skip_while.md @@ -2,7 +2,7 @@ title: skip while categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Skip elements of the input while a predicate is true. usage: | @@ -39,7 +39,7 @@ contributors: false Skip while the element is negative. ```nu -> [-2 0 2 -1] | skip while {|x| $x < 0 } +> [-2 0 2 -1] | skip while $it < 0 ╭───┬────╮ │ 0 │ 0 │ │ 1 │ 2 │ @@ -61,7 +61,7 @@ Skip while the element is negative using stored condition. Skip while the field value is negative. ```nu -> [{a: -2} {a: 0} {a: 2} {a: -1}] | skip while {|x| $x.a < 0 } +> [{a: -2} {a: 0} {a: 2} {a: -1}] | skip while a < 0 ╭───┬────╮ │ # │ a │ ├───┼────┤ diff --git a/commands/docs/sleep.md b/commands/docs/sleep.md index 370d43a4421..8c824b7b03d 100644 --- a/commands/docs/sleep.md +++ b/commands/docs/sleep.md @@ -2,7 +2,7 @@ title: sleep categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Delay for a specified amount of time. usage: | diff --git a/commands/docs/slice.md b/commands/docs/slice.md index 47b6d0fd570..538c8f06136 100644 --- a/commands/docs/slice.md +++ b/commands/docs/slice.md @@ -2,7 +2,7 @@ title: slice categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Return only the selected rows. usage: | diff --git a/commands/docs/sort-by.md b/commands/docs/sort-by.md index e7631ce9112..31635841bae 100644 --- a/commands/docs/sort-by.md +++ b/commands/docs/sort-by.md @@ -2,7 +2,7 @@ title: sort-by categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Sort by the given cell path or closure. usage: | diff --git a/commands/docs/sort.md b/commands/docs/sort.md index dfece27bb4b..03c062ed534 100644 --- a/commands/docs/sort.md +++ b/commands/docs/sort.md @@ -2,7 +2,7 @@ title: sort categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Sort the input in increasing order. usage: | diff --git a/commands/docs/source-env.md b/commands/docs/source-env.md index 07280cdf3ac..bdb88b08bcf 100644 --- a/commands/docs/source-env.md +++ b/commands/docs/source-env.md @@ -2,7 +2,7 @@ title: source-env categories: | core -version: 0.115.1 +version: 0.116.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 d102f37c631..a8a83405a80 100644 --- a/commands/docs/source.md +++ b/commands/docs/source.md @@ -2,7 +2,7 @@ title: source categories: | core -version: 0.115.1 +version: 0.116.0 core: | Runs a script file in the current context. usage: | diff --git a/commands/docs/split.md b/commands/docs/split.md index ecddee13644..280b60205b8 100644 --- a/commands/docs/split.md +++ b/commands/docs/split.md @@ -2,7 +2,7 @@ title: split categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Split contents across desired subcommand (like row, column) via the separator. usage: | diff --git a/commands/docs/split_cell-path.md b/commands/docs/split_cell-path.md index c12c88a2649..47e17e63740 100644 --- a/commands/docs/split_cell-path.md +++ b/commands/docs/split_cell-path.md @@ -2,7 +2,7 @@ title: split cell-path categories: | conversions -version: 0.115.1 +version: 0.116.0 conversions: | Split a cell-path into its components. usage: | diff --git a/commands/docs/split_chars.md b/commands/docs/split_chars.md index 8fd80301bab..041a8e83ebb 100644 --- a/commands/docs/split_chars.md +++ b/commands/docs/split_chars.md @@ -2,7 +2,7 @@ title: split chars categories: | strings -version: 0.115.1 +version: 0.116.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 a3ad7548bba..2720d14d889 100644 --- a/commands/docs/split_column.md +++ b/commands/docs/split_column.md @@ -2,7 +2,7 @@ title: split column categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Split a string into multiple columns using a separator. usage: | diff --git a/commands/docs/split_list.md b/commands/docs/split_list.md index 7ae6ddbfaaa..311af3e5956 100644 --- a/commands/docs/split_list.md +++ b/commands/docs/split_list.md @@ -2,7 +2,7 @@ title: split list categories: | filters -version: 0.115.1 +version: 0.116.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 14d86f59668..6dc4f55c70f 100644 --- a/commands/docs/split_row.md +++ b/commands/docs/split_row.md @@ -2,7 +2,7 @@ title: split row categories: | strings -version: 0.115.1 +version: 0.116.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 b5c541e0c0d..ed3e083d78a 100644 --- a/commands/docs/split_words.md +++ b/commands/docs/split_words.md @@ -2,7 +2,7 @@ title: split words categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Split a string's words into separate rows. usage: | diff --git a/commands/docs/start.md b/commands/docs/start.md index 0f0eb7d98df..58a70605012 100644 --- a/commands/docs/start.md +++ b/commands/docs/start.md @@ -2,7 +2,7 @@ title: start categories: | filesystem -version: 0.115.1 +version: 0.116.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 2768bf8178a..38ab8053709 100644 --- a/commands/docs/stor.md +++ b/commands/docs/stor.md @@ -2,7 +2,7 @@ title: stor categories: | database -version: 0.115.1 +version: 0.116.0 database: | Various commands for working with the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_create.md b/commands/docs/stor_create.md index ed54a68521b..6325b9f5f7a 100644 --- a/commands/docs/stor_create.md +++ b/commands/docs/stor_create.md @@ -2,7 +2,7 @@ title: stor create categories: | database -version: 0.115.1 +version: 0.116.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 bb094ff8f91..5c8c2753887 100644 --- a/commands/docs/stor_delete.md +++ b/commands/docs/stor_delete.md @@ -2,7 +2,7 @@ title: stor delete categories: | database -version: 0.115.1 +version: 0.116.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 7e9208c2044..f23f925ba53 100644 --- a/commands/docs/stor_export.md +++ b/commands/docs/stor_export.md @@ -2,7 +2,7 @@ title: stor export categories: | database -version: 0.115.1 +version: 0.116.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 632f46c50ac..6b324edf0c3 100644 --- a/commands/docs/stor_import.md +++ b/commands/docs/stor_import.md @@ -2,7 +2,7 @@ title: stor import categories: | database -version: 0.115.1 +version: 0.116.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 0e29a154fe3..0c70342dc10 100644 --- a/commands/docs/stor_insert.md +++ b/commands/docs/stor_insert.md @@ -2,7 +2,7 @@ title: stor insert categories: | database -version: 0.115.1 +version: 0.116.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 48069888965..4f6b0923ec1 100644 --- a/commands/docs/stor_open.md +++ b/commands/docs/stor_open.md @@ -2,7 +2,7 @@ title: stor open categories: | database -version: 0.115.1 +version: 0.116.0 database: | Opens the in-memory sqlite database. usage: | diff --git a/commands/docs/stor_reset.md b/commands/docs/stor_reset.md index f94f4603256..2d75e7dd719 100644 --- a/commands/docs/stor_reset.md +++ b/commands/docs/stor_reset.md @@ -2,7 +2,7 @@ title: stor reset categories: | database -version: 0.115.1 +version: 0.116.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 2370a1d3612..75c5b067073 100644 --- a/commands/docs/stor_update.md +++ b/commands/docs/stor_update.md @@ -2,7 +2,7 @@ title: stor update categories: | database -version: 0.115.1 +version: 0.116.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 49e13ab801d..6f091cd88e3 100644 --- a/commands/docs/str.md +++ b/commands/docs/str.md @@ -2,7 +2,7 @@ title: str categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Various commands for working with string data. usage: | diff --git a/commands/docs/str_camel-case.md b/commands/docs/str_camel-case.md index 459ac8fef9d..ce7f0145197 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.115.1 +version: 0.116.0 strings: | Convert a string to camelCase. usage: | diff --git a/commands/docs/str_capitalize.md b/commands/docs/str_capitalize.md index 4be79c61db2..d74444ffdee 100644 --- a/commands/docs/str_capitalize.md +++ b/commands/docs/str_capitalize.md @@ -2,7 +2,7 @@ title: str capitalize categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Capitalize the first letter of text. usage: | diff --git a/commands/docs/str_contains.md b/commands/docs/str_contains.md index a74d1ad6fa6..f08c6221099 100644 --- a/commands/docs/str_contains.md +++ b/commands/docs/str_contains.md @@ -2,7 +2,7 @@ title: str contains categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Checks if string input contains a substring. usage: | diff --git a/commands/docs/str_distance.md b/commands/docs/str_distance.md index b3b25834f35..311595c0205 100644 --- a/commands/docs/str_distance.md +++ b/commands/docs/str_distance.md @@ -2,7 +2,7 @@ title: str distance categories: | strings -version: 0.115.1 +version: 0.116.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 aaea4dfe52c..5449385374e 100644 --- a/commands/docs/str_downcase.md +++ b/commands/docs/str_downcase.md @@ -2,7 +2,7 @@ title: str downcase categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Convert text to lowercase. usage: | diff --git a/commands/docs/str_ends-with.md b/commands/docs/str_ends-with.md index a50ca4244eb..9553175a3ed 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.115.1 +version: 0.116.0 strings: | Check if an input ends with a string. usage: | diff --git a/commands/docs/str_escape-regex.md b/commands/docs/str_escape-regex.md index c28f103dfe4..e4ff59698dc 100644 --- a/commands/docs/str_escape-regex.md +++ b/commands/docs/str_escape-regex.md @@ -2,7 +2,7 @@ title: str escape-regex categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Escapes special characters in the input string with '\'. usage: | diff --git a/commands/docs/str_expand.md b/commands/docs/str_expand.md index 11184a9040e..593cbf29fef 100644 --- a/commands/docs/str_expand.md +++ b/commands/docs/str_expand.md @@ -2,7 +2,7 @@ title: str expand categories: | strings -version: 0.115.1 +version: 0.116.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 4dcb2cd47da..42a15c2b0c3 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.115.1 +version: 0.116.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 de677fd5e7d..3f2be512e6f 100644 --- a/commands/docs/str_join.md +++ b/commands/docs/str_join.md @@ -2,7 +2,7 @@ title: str join categories: | strings -version: 0.115.1 +version: 0.116.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 c1c2e4213f3..4e30ca40beb 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.115.1 +version: 0.116.0 strings: | Convert a string to kebab-case. usage: | diff --git a/commands/docs/str_length.md b/commands/docs/str_length.md index e987d3adcde..73786791349 100644 --- a/commands/docs/str_length.md +++ b/commands/docs/str_length.md @@ -2,7 +2,7 @@ title: str length categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Output the length of any strings in the pipeline. usage: | diff --git a/commands/docs/str_lowercase.md b/commands/docs/str_lowercase.md index 2d1a7a56230..11aea011684 100644 --- a/commands/docs/str_lowercase.md +++ b/commands/docs/str_lowercase.md @@ -2,7 +2,7 @@ title: str lowercase categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Convert text to lowercase. usage: | diff --git a/commands/docs/str_pascal-case.md b/commands/docs/str_pascal-case.md index f15396e1956..8d9de426974 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.115.1 +version: 0.116.0 strings: | Convert a string to PascalCase. usage: | diff --git a/commands/docs/str_replace.md b/commands/docs/str_replace.md index 90cf5f37e46..982a76a3425 100644 --- a/commands/docs/str_replace.md +++ b/commands/docs/str_replace.md @@ -2,7 +2,7 @@ title: str replace categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Find and replace text in the input string. usage: | diff --git a/commands/docs/str_reverse.md b/commands/docs/str_reverse.md index afe339eb35a..22a2937ed4a 100644 --- a/commands/docs/str_reverse.md +++ b/commands/docs/str_reverse.md @@ -2,7 +2,7 @@ title: str reverse categories: | strings -version: 0.115.1 +version: 0.116.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 e5df039ebde..7dc488f0ae6 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.115.1 +version: 0.116.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 863e4220a42..05cb89ad3f5 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.115.1 +version: 0.116.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 f9b4cb18868..c70e4dae036 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.115.1 +version: 0.116.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 68ac98957c5..2607483f94b 100644 --- a/commands/docs/str_stats.md +++ b/commands/docs/str_stats.md @@ -2,7 +2,7 @@ title: str stats categories: | strings -version: 0.115.1 +version: 0.116.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 938ca3b8bd0..bbefcda900a 100644 --- a/commands/docs/str_substring.md +++ b/commands/docs/str_substring.md @@ -2,7 +2,7 @@ title: str substring categories: | strings -version: 0.115.1 +version: 0.116.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 c563a135d31..fa9d3005b0e 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.115.1 +version: 0.116.0 strings: | Convert a string to Title Case. usage: | diff --git a/commands/docs/str_trim.md b/commands/docs/str_trim.md index f6cbcd8a993..c1f67299603 100644 --- a/commands/docs/str_trim.md +++ b/commands/docs/str_trim.md @@ -2,7 +2,7 @@ title: str trim categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Trim whitespace or specific character. usage: | diff --git a/commands/docs/str_upcase.md b/commands/docs/str_upcase.md index c3543518fb4..9ad97f4f356 100644 --- a/commands/docs/str_upcase.md +++ b/commands/docs/str_upcase.md @@ -2,7 +2,7 @@ title: str upcase categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Convert text to uppercase. usage: | diff --git a/commands/docs/str_uppercase.md b/commands/docs/str_uppercase.md index 401e57445b5..77bb1335d08 100644 --- a/commands/docs/str_uppercase.md +++ b/commands/docs/str_uppercase.md @@ -2,7 +2,7 @@ title: str uppercase categories: | strings -version: 0.115.1 +version: 0.116.0 strings: | Convert text to uppercase. usage: | diff --git a/commands/docs/sys.md b/commands/docs/sys.md index 921f5b748cb..44cf1c9bcb4 100644 --- a/commands/docs/sys.md +++ b/commands/docs/sys.md @@ -2,7 +2,7 @@ title: sys categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about the system. usage: | diff --git a/commands/docs/sys_cpu.md b/commands/docs/sys_cpu.md index f146f63c50f..3bc9203ce93 100644 --- a/commands/docs/sys_cpu.md +++ b/commands/docs/sys_cpu.md @@ -2,7 +2,7 @@ title: sys cpu categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about the system CPUs. usage: | diff --git a/commands/docs/sys_disks.md b/commands/docs/sys_disks.md index ba25cedc700..6d2208ce97b 100644 --- a/commands/docs/sys_disks.md +++ b/commands/docs/sys_disks.md @@ -2,7 +2,7 @@ title: sys disks categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about the system disks. usage: | diff --git a/commands/docs/sys_host.md b/commands/docs/sys_host.md index 80a0daa0090..930656b6db9 100644 --- a/commands/docs/sys_host.md +++ b/commands/docs/sys_host.md @@ -2,7 +2,7 @@ title: sys host categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about the system host. usage: | diff --git a/commands/docs/sys_mem.md b/commands/docs/sys_mem.md index c9119c7a880..487293ec660 100644 --- a/commands/docs/sys_mem.md +++ b/commands/docs/sys_mem.md @@ -2,7 +2,7 @@ title: sys mem categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about the system memory. usage: | diff --git a/commands/docs/sys_net.md b/commands/docs/sys_net.md index a44db43967b..e6bb8f6599c 100644 --- a/commands/docs/sys_net.md +++ b/commands/docs/sys_net.md @@ -2,7 +2,7 @@ title: sys net categories: | system -version: 0.115.1 +version: 0.116.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 ba1d774f36f..45303e66cdd 100644 --- a/commands/docs/sys_temp.md +++ b/commands/docs/sys_temp.md @@ -2,7 +2,7 @@ title: sys temp categories: | system -version: 0.115.1 +version: 0.116.0 system: | View the temperatures of system components. usage: | diff --git a/commands/docs/sys_users.md b/commands/docs/sys_users.md index 99667d3f80c..dd0b18472fb 100644 --- a/commands/docs/sys_users.md +++ b/commands/docs/sys_users.md @@ -2,7 +2,7 @@ title: sys users categories: | system -version: 0.115.1 +version: 0.116.0 system: | View information about the users on the system. usage: | diff --git a/commands/docs/table.md b/commands/docs/table.md index b2358885ebf..ceddb5dcbd2 100644 --- a/commands/docs/table.md +++ b/commands/docs/table.md @@ -2,7 +2,7 @@ title: table categories: | viewers -version: 0.115.1 +version: 0.116.0 viewers: | Render the table. usage: | diff --git a/commands/docs/take.md b/commands/docs/take.md index 235c64e380f..796838f63a6 100644 --- a/commands/docs/take.md +++ b/commands/docs/take.md @@ -2,7 +2,7 @@ title: take categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Take only the first n elements of a list, or the first n bytes of a binary value. For binary input, n can also be specified as a filesize. usage: | diff --git a/commands/docs/take_until.md b/commands/docs/take_until.md index 2b3ec43d9a6..864fb1507b3 100644 --- a/commands/docs/take_until.md +++ b/commands/docs/take_until.md @@ -2,7 +2,7 @@ title: take until categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Take elements of the input until a predicate is true. usage: | @@ -43,7 +43,7 @@ contributors: false Take until the element is positive. ```nu -> [-1 -2 9 1] | take until {|x| $x > 0 } +> [-1 -2 9 1] | take until $it > 0 ╭───┬────╮ │ 0 │ -1 │ │ 1 │ -2 │ @@ -63,7 +63,7 @@ Take until the element is positive using stored condition. Take until the field value is positive. ```nu -> [{a: -1} {a: -2} {a: 9} {a: 1}] | take until {|x| $x.a > 0 } +> [{a: -1} {a: -2} {a: 9} {a: 1}] | take until a > 0 ╭───┬────╮ │ # │ a │ ├───┼────┤ diff --git a/commands/docs/take_while.md b/commands/docs/take_while.md index 6f21aeaf429..e4b0368bc39 100644 --- a/commands/docs/take_while.md +++ b/commands/docs/take_while.md @@ -2,7 +2,7 @@ title: take while categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Take elements of the input while a predicate is true. usage: | @@ -43,7 +43,7 @@ contributors: false Take while the element is negative. ```nu -> [-1 -2 9 1] | take while {|x| $x < 0 } +> [-1 -2 9 1] | take while $it < 0 ╭───┬────╮ │ 0 │ -1 │ │ 1 │ -2 │ @@ -63,7 +63,7 @@ Take while the element is negative using stored condition. Take while the field value is negative. ```nu -> [{a: -1} {a: -2} {a: 9} {a: 1}] | take while {|x| $x.a < 0 } +> [{a: -1} {a: -2} {a: 9} {a: 1}] | take while a < 0 ╭───┬────╮ │ # │ a │ ├───┼────┤ diff --git a/commands/docs/tee.md b/commands/docs/tee.md index e43a67185a3..dd2345eb6ae 100644 --- a/commands/docs/tee.md +++ b/commands/docs/tee.md @@ -2,7 +2,7 @@ title: tee categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Copy a stream to another command in parallel. usage: | diff --git a/commands/docs/term.md b/commands/docs/term.md index a47a064dc34..07f3f3d8bc9 100644 --- a/commands/docs/term.md +++ b/commands/docs/term.md @@ -2,7 +2,7 @@ title: term categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Commands for querying information about the terminal. usage: | diff --git a/commands/docs/term_query.md b/commands/docs/term_query.md index ce329c400be..75cbd7b0b8f 100644 --- a/commands/docs/term_query.md +++ b/commands/docs/term_query.md @@ -2,7 +2,7 @@ title: term query categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Query the terminal for information. usage: | diff --git a/commands/docs/term_size.md b/commands/docs/term_size.md index a4dd694b045..9a361608137 100644 --- a/commands/docs/term_size.md +++ b/commands/docs/term_size.md @@ -2,7 +2,7 @@ title: term size categories: | platform -version: 0.115.1 +version: 0.116.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 2012de3a1c4..5d72c878750 100644 --- a/commands/docs/timeit.md +++ b/commands/docs/timeit.md @@ -2,7 +2,7 @@ title: timeit categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Time how long it takes a closure to run. usage: | diff --git a/commands/docs/to.md b/commands/docs/to.md index 6ba04e05729..9eba0065f69 100644 --- a/commands/docs/to.md +++ b/commands/docs/to.md @@ -2,7 +2,7 @@ title: to categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Translate structured data to various formats. usage: | diff --git a/commands/docs/to_csv.md b/commands/docs/to_csv.md index 63c4c013577..19d713a0cd7 100644 --- a/commands/docs/to_csv.md +++ b/commands/docs/to_csv.md @@ -2,7 +2,7 @@ title: to csv categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert table into .csv text . usage: | diff --git a/commands/docs/to_html.md b/commands/docs/to_html.md index 56e59e06d73..5f6fe75f3b7 100644 --- a/commands/docs/to_html.md +++ b/commands/docs/to_html.md @@ -2,7 +2,7 @@ title: to html categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert table into simple HTML. usage: | diff --git a/commands/docs/to_json.md b/commands/docs/to_json.md index c8d291b3173..8da0a756cfc 100644 --- a/commands/docs/to_json.md +++ b/commands/docs/to_json.md @@ -2,7 +2,7 @@ title: to json categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Converts table data into JSON text. usage: | diff --git a/commands/docs/to_kdl.md b/commands/docs/to_kdl.md index e29ce0318f3..f240ac85e2a 100644 --- a/commands/docs/to_kdl.md +++ b/commands/docs/to_kdl.md @@ -2,7 +2,7 @@ title: to kdl categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Converts structured data into KDL text. usage: | diff --git a/commands/docs/to_md.md b/commands/docs/to_md.md index 63f5a8a4994..786b1d3512b 100644 --- a/commands/docs/to_md.md +++ b/commands/docs/to_md.md @@ -2,7 +2,7 @@ title: to md categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert table into simple Markdown. usage: | diff --git a/commands/docs/to_msgpack.md b/commands/docs/to_msgpack.md index 1388a3ab229..fe0b4cfa38e 100644 --- a/commands/docs/to_msgpack.md +++ b/commands/docs/to_msgpack.md @@ -2,7 +2,7 @@ title: to msgpack categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert Nu values into MessagePack. usage: | diff --git a/commands/docs/to_msgpackz.md b/commands/docs/to_msgpackz.md index be5fe938e69..21b0158a6ac 100644 --- a/commands/docs/to_msgpackz.md +++ b/commands/docs/to_msgpackz.md @@ -2,7 +2,7 @@ title: to msgpackz categories: | formats -version: 0.115.1 +version: 0.116.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 3fb29d7f966..a5f9942d7c5 100644 --- a/commands/docs/to_nuon.md +++ b/commands/docs/to_nuon.md @@ -2,7 +2,7 @@ title: to nuon categories: | formats -version: 0.115.1 +version: 0.116.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 c595409fe8a..0e728b33d0a 100644 --- a/commands/docs/to_plist.md +++ b/commands/docs/to_plist.md @@ -2,7 +2,7 @@ title: to plist categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert Nu values into plist usage: | diff --git a/commands/docs/to_text.md b/commands/docs/to_text.md index a589db12ac9..0badc968d8d 100644 --- a/commands/docs/to_text.md +++ b/commands/docs/to_text.md @@ -2,7 +2,7 @@ title: to text categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert data into plain text format. usage: | diff --git a/commands/docs/to_toml.md b/commands/docs/to_toml.md index 31dcdfea476..f54e382c187 100644 --- a/commands/docs/to_toml.md +++ b/commands/docs/to_toml.md @@ -2,7 +2,7 @@ title: to toml categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert record into .toml text. usage: | diff --git a/commands/docs/to_tsv.md b/commands/docs/to_tsv.md index 2ebfa692436..97e129356ad 100644 --- a/commands/docs/to_tsv.md +++ b/commands/docs/to_tsv.md @@ -2,7 +2,7 @@ title: to tsv categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert table into .tsv text. usage: | diff --git a/commands/docs/to_txt.md b/commands/docs/to_txt.md index d6f2a2fd022..a59ef065158 100644 --- a/commands/docs/to_txt.md +++ b/commands/docs/to_txt.md @@ -2,7 +2,7 @@ title: to txt categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert data into plain text format. usage: | diff --git a/commands/docs/to_xml.md b/commands/docs/to_xml.md index c1381f6c9f4..c6a8831e237 100644 --- a/commands/docs/to_xml.md +++ b/commands/docs/to_xml.md @@ -2,7 +2,7 @@ title: to xml categories: | formats -version: 0.115.1 +version: 0.116.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 0ce61c05176..323d7e0a04e 100644 --- a/commands/docs/to_yaml.md +++ b/commands/docs/to_yaml.md @@ -2,7 +2,7 @@ title: to yaml categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert table into .yaml/.yml text. usage: | @@ -27,12 +27,12 @@ contributors: false ## Flags - `--serialize, -s`: Serialize nushell types that cannot be deserialized. - - `--non-roundtrip {string}`: How to handle values that are non-roundtrippable. + - `--non-roundtrip {oneof}`: How to handle values that are non-roundtrippable. - `--spec {string}`: YAML spec version ('1.1' or '1.2' (default)). - `--add-directives, -d`: Add YAML document directives. - `--multiple, -m`: Given a list, serialize a multi document stream. - `--indent, -i {int}`: Configure the indent. - - `--compact-list-indent`: Emit lists with a more compact indentation style. + - `--list-indent {string}`: Nested list indentation style ('compact' (default) or 'indented') - `--quote, -q {string}`: String quote style ('auto' (default), 'single' or 'double') diff --git a/commands/docs/to_yml.md b/commands/docs/to_yml.md index ed57adbb3c6..ff2d3c0f8ca 100644 --- a/commands/docs/to_yml.md +++ b/commands/docs/to_yml.md @@ -2,7 +2,7 @@ title: to yml categories: | formats -version: 0.115.1 +version: 0.116.0 formats: | Convert table into .yaml/.yml text. usage: | @@ -27,12 +27,12 @@ contributors: false ## Flags - `--serialize, -s`: Serialize nushell types that cannot be deserialized. - - `--non-roundtrip {string}`: How to handle values that are non-roundtrippable. + - `--non-roundtrip {oneof}`: How to handle values that are non-roundtrippable. - `--spec {string}`: YAML spec version ('1.1' or '1.2' (default)). - `--add-directives, -d`: Add YAML document directives. - `--multiple, -m`: Given a list, serialize a multi document stream. - `--indent, -i {int}`: Configure the indent. - - `--compact-list-indent`: Emit lists with a more compact indentation style. + - `--list-indent {string}`: Nested list indentation style ('compact' (default) or 'indented') - `--quote, -q {string}`: String quote style ('auto' (default), 'single' or 'double') diff --git a/commands/docs/touch.md b/commands/docs/touch.md index 03f790bfb42..58b829a3257 100644 --- a/commands/docs/touch.md +++ b/commands/docs/touch.md @@ -2,7 +2,7 @@ title: touch categories: | filesystem -version: 0.115.1 +version: 0.116.0 filesystem: | Creates one or more files. usage: | diff --git a/commands/docs/transpose.md b/commands/docs/transpose.md index ae5a9ac7189..aa928e51454 100644 --- a/commands/docs/transpose.md +++ b/commands/docs/transpose.md @@ -2,7 +2,7 @@ title: transpose categories: | filters -version: 0.115.1 +version: 0.116.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 3b7f985da84..233c71cd71a 100644 --- a/commands/docs/try.md +++ b/commands/docs/try.md @@ -2,7 +2,7 @@ title: try categories: | core -version: 0.115.1 +version: 0.116.0 core: | Try to run a block, if it fails optionally run a catch closure. usage: | diff --git a/commands/docs/tui.md b/commands/docs/tui.md new file mode 100644 index 00000000000..584b8da1a6f --- /dev/null +++ b/commands/docs/tui.md @@ -0,0 +1,72 @@ +--- +title: tui +categories: | + viewers +version: 0.116.0 +viewers: | + Build interactive terminal UIs by composing `tui` subcommands. +usage: | + Build interactive terminal UIs by composing `tui` subcommands. +editLink: false +contributors: false +--- + + +# `tui` for [viewers](/commands/categories/viewers.md) + +
Build interactive terminal UIs by composing `tui` subcommands.
+ +## Command Type + +`built-in` + +## Signature + +```> tui {flags} ``` + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | string | +## Examples + +List TUI subcommands +```nu +> tui + +``` + +## Notes +You must use one of the following subcommands. Using this command as-is will only produce this help message. + +Builders (`tui table`, `tui split`, ...) append widgets to a `tui` value. `tui run` shows it and returns one record: `{action, focused, selected, page, values, rows, live}`, where `values` holds every widget's state by id. `tui debug` returns the same record plus the painted `screen` and the resolved layout, for scripts and tests. + +Data: a value piped into a builder is the shared data list. Lists and streams are collected in full (up to 100k rows); an external command's output (`tail -f log | tui log`) and an unbounded range (`1..`) stay live, and their rows appear as they are produced. When the TUI closes while an external command is still running, it is stopped. A widget can have its own rows with `--data`, or by piping into it inside a container's child list: `tui split [(ls | tui table) (ps | tui table)]`. `--from ` (with an optional closure) makes a widget follow another's highlighted row. + +Hooks: `tui bind`, menu actions, `tui button`, `--on-select`, and the `tui run` refresh closure all receive the state record and may return nothing, a new data list, or `{action: submit|quit, selected: ...}`. + +Layout: `tui split --sizes [30% 1fr]` arranges children; `tui box` groups them with a border; `tui tab` makes a page. Colors come from `$env.config.tui`. + +## Subcommands: + +| name | description | type | +| ------------------------------------------------ | ------------------------------------------------------------------------------------------------------- | -------- | +| [`tui bind`](/commands/docs/tui_bind.md) | Run a hook when a key is pressed anywhere in the TUI. | built-in | +| [`tui box`](/commands/docs/tui_box.md) | Group widgets inside a titled, bordered box. | built-in | +| [`tui button`](/commands/docs/tui_button.md) | Add a button that runs a hook, or submits its label, when activated. | built-in | +| [`tui debug`](/commands/docs/tui_debug.md) | Render a TUI without a terminal and return the screen plus the resolved layout, focus order, and pages. | built-in | +| [`tui label`](/commands/docs/tui_label.md) | Add static text: inline, or as the title bar (--title) or status bar (--status). | built-in | +| [`tui log`](/commands/docs/tui_log.md) | Add an append-only log view. Streamed rows appear at the bottom. | built-in | +| [`tui menu`](/commands/docs/tui_menu.md) | Add a menu bar with mnemonics, dropdown items, and actions. | built-in | +| [`tui preview`](/commands/docs/tui_preview.md) | Show text for the selected table, tree, or select row. Arrow keys stay on the source. | built-in | +| [`tui progress`](/commands/docs/tui_progress.md) | Add a progress bar. | built-in | +| [`tui run`](/commands/docs/tui_run.md) | Run a composed TUI until the user quits or submits a selection. | built-in | +| [`tui search`](/commands/docs/tui_search.md) | Add a search box that filters tables, logs, trees, and selects as you type. | built-in | +| [`tui select`](/commands/docs/tui_select.md) | Add a radio list of items, or a checkbox list with --multi. | built-in | +| [`tui split`](/commands/docs/tui_split.md) | Lay out child widgets side by side (or stacked with --vertical) with draggable dividers. | built-in | +| [`tui tab`](/commands/docs/tui_tab.md) | Group widgets as a page in the tab bar. | built-in | +| [`tui table`](/commands/docs/tui_table.md) | Add a navigable table. Pipeline rows become the rows; scalars show as one `item` column. | built-in | +| [`tui textbox`](/commands/docs/tui_textbox.md) | Add an editable text field. Tab to focus it, then type. | built-in | +| [`tui tree`](/commands/docs/tui_tree.md) | Add a tree for nested records or a directory walk. | built-in | \ No newline at end of file diff --git a/commands/docs/tui_bind.md b/commands/docs/tui_bind.md new file mode 100644 index 00000000000..6ed8b24389f --- /dev/null +++ b/commands/docs/tui_bind.md @@ -0,0 +1,65 @@ +--- +title: tui bind +categories: | + viewers +version: 0.116.0 +viewers: | + Run a hook when a key is pressed anywhere in the TUI. +usage: | + Run a hook when a key is pressed anywhere in the TUI. +editLink: false +contributors: false +--- + + +# `tui bind` for [viewers](/commands/categories/viewers.md) + +
Run a hook when a key is pressed anywhere in the TUI.
+ +## Command Type + +`built-in` + +## Signature + +```> tui bind {flags} (key) (hook)``` + +## Parameters + + - `key`: Chord like 'ctrl+s', or a {modifier, keycode} record. + - `hook`: Closure run with the state record. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Reload the rows with Ctrl+R +```nu +> ls | tui table | tui bind ctrl+r {|| ls } | tui run + +``` + +Submit the highlighted row's name with s +```nu +> ls | tui table | tui bind s {|state| {action: submit, selected: $state.selected.name} } | tui run + +``` + +Use a reedline-style key record +```nu +> [a b] | tui table | tui bind {modifier: control, keycode: char_q} {|| {action: quit} } | tui debug --keys ctrl+q | get action + +``` + +## Notes +The key is a chord string like `ctrl+s`, `alt+r`, `f5`, or `x`, or a reedline-style record `{modifier: control, keycode: char_s}` as in `$env.config.keybindings`. + +The hook receives the state record (`{action, focused, selected, page, values, rows, live}`) as `$in` and as its first parameter. Return nothing to change nothing, a value to replace the data list, or `{action: submit, selected: ...}` / `{action: quit}` to end the TUI. + +Binds take precedence over the built-in keys, except Ctrl+C. A bind without a modifier does not fire while typing in a search or text box. \ No newline at end of file diff --git a/commands/docs/tui_box.md b/commands/docs/tui_box.md new file mode 100644 index 00000000000..31916a4711a --- /dev/null +++ b/commands/docs/tui_box.md @@ -0,0 +1,54 @@ +--- +title: tui box +categories: | + viewers +version: 0.116.0 +viewers: | + Group widgets inside a titled, bordered box. +usage: | + Group widgets inside a titled, bordered box. +editLink: false +contributors: false +--- + + +# `tui box` for [viewers](/commands/categories/viewers.md) + +
Group widgets inside a titled, bordered box.
+ +## Command Type + +`built-in` + +## Signature + +```> tui box {flags} (title) (children)``` + +## Flags + + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + +## Parameters + + - `title`: Box title. + - `children`: Widgets inside the box, e.g. [(tui search) (tui table)]. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +A titled box inside a split +```nu +> ls | tui split [(tui box "list" [(tui table)]) (tui preview)] | tui run + +``` + +## Notes +Children stack vertically inside the border. Boxes nest and can sit inside `tui split`. Children are `tui` values built in parentheses: `tui box "files" [(tui search) (tui table)]`. \ No newline at end of file diff --git a/commands/docs/tui_button.md b/commands/docs/tui_button.md new file mode 100644 index 00000000000..68f9b60c7bd --- /dev/null +++ b/commands/docs/tui_button.md @@ -0,0 +1,60 @@ +--- +title: tui button +categories: | + viewers +version: 0.116.0 +viewers: | + Add a button that runs a hook, or submits its label, when activated. +usage: | + Add a button that runs a hook, or submits its label, when activated. +editLink: false +contributors: false +--- + + +# `tui button` for [viewers](/commands/categories/viewers.md) + +
Add a button that runs a hook, or submits its label, when activated.
+ +## Command Type + +`built-in` + +## Signature + +```> tui button {flags} (label) (hook)``` + +## Flags + + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + +## Parameters + + - `label`: Button text. + - `hook`: Closure run with the state record when activated. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +A yes/no confirm +```nu +> tui label "Delete everything?" | tui button Yes | tui button No | tui debug --keys [tab enter] | get selected + +``` + +A button that saves the text box and quits +```nu +> tui textbox --id name | tui button Save {|s| $s.values.name | save name.txt; {action: quit} } | tui run + +``` + +## Notes +Tab to the button and press Enter or Space, or click it. With a hook closure the button behaves like `tui bind`: the closure receives the state record and may return a new data list or `{action: submit|quit, ...}`. Without one, activating submits the label, so `tui button Yes | tui button No` is a confirm dialog. \ No newline at end of file diff --git a/commands/docs/tui_debug.md b/commands/docs/tui_debug.md new file mode 100644 index 00000000000..f127d6ac239 --- /dev/null +++ b/commands/docs/tui_debug.md @@ -0,0 +1,80 @@ +--- +title: tui debug +categories: | + viewers +version: 0.116.0 +viewers: | + Render a TUI without a terminal and return the screen plus the resolved layout, focus order, and pages. +usage: | + Render a TUI without a terminal and return the screen plus the resolved layout, focus order, and pages. +editLink: false +contributors: false +--- + + +# `tui debug` for [viewers](/commands/categories/viewers.md) + +
Render a TUI without a terminal and return the screen plus the resolved layout, focus order, and pages.
+ +## Command Type + +`built-in` + +## Signature + +```> tui debug {flags} (hook)``` + +## Flags + + - `--keys, -k {oneof, string>}`: Key tokens to replay before painting. + - `--until, -u {closure(any)}`: Stop replaying keys once this returns true for the state record. + - `--size, -s {list}`: Canvas [width height]. Default [80 24]. + - `--dialog, -d`: Paint as a floating popup. + +## Parameters + + - `hook`: Hook whose output replaces the data list, run once. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| tui | record | +| any | record | +## Examples + +Paint a title and status bar +```nu +> tui label --title "Demo" | tui label --status "ready" | tui debug | get screen + +``` + +Replay keys and read the selection +```nu +> [{name: a}, {name: b}] | tui table | tui debug --keys [down enter] | get selected.name + +``` + +See where each widget landed +```nu +> ls | tui split [(tui table) (tui preview)] | tui debug | get widgets.0.children | select id rect + +``` + +Stop replaying once a condition holds +```nu +> [a b c] | tui table | tui debug --keys [down down down] --until {|s| $s.values.table-0.index == 1 } | get values.table-0.index + +``` + +## Notes +Use this to test a TUI in a script or CI, or to see why it looks the way it does. The result record has the same fields as `tui run` (action, focused, selected, page, values, rows, live) plus: +- `screen`: the painted buffer as a string +- `widgets`: the widget tree with each widget's layout `rect`, `focusable`, and per-kind fields: tables show `resolved_columns` and filtered `rows`; searches show their `query`; previews and `--from` widgets show the `source` they follow; lists show the `search_scope` that filters them +- `focus`: the tab order and the default focus +- `pages`: the tab bar entries + +`--keys` replays tokens before painting, as a comma-separated string or a list: enter, esc, tab, shift+tab, up, down, left, right, home, end, pageup, pagedown, backspace, delete, space, insert, ctrl+c, alt+a, f1, a single character, `type:hello`, `click:COL,ROW`, `drag:COL,ROW`, `scroll-up`, `scroll-down`. `action` is `render` when the keys finished without Enter or quit. `--until {|state| ...}` stops the replay early once the closure returns true. + +A live stream is read for up to 5 seconds (and no more rows than the widgets keep) before painting. A hook closure runs once with the state record, as `tui run` would. \ No newline at end of file diff --git a/commands/docs/tui_label.md b/commands/docs/tui_label.md new file mode 100644 index 00000000000..378d57ee694 --- /dev/null +++ b/commands/docs/tui_label.md @@ -0,0 +1,71 @@ +--- +title: tui label +categories: | + viewers +version: 0.116.0 +viewers: | + Add static text: inline, or as the title bar (--title) or status bar (--status). +usage: | + Add static text: inline, or as the title bar (--title) or status bar (--status). +editLink: false +contributors: false +--- + + +# `tui label` for [viewers](/commands/categories/viewers.md) + +
Add static text: inline, or as the title bar (--title) or status bar (--status).
+ +## Command Type + +`built-in` + +## Signature + +```> tui label {flags} (text)``` + +## Flags + + - `--title`: Show as the title bar at the top. + - `--status`: Show as the status bar at the bottom. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + - `--data {any}`: Data for this widget alone, instead of the outer pipeline's. + - `--from {string}`: Id of the table, tree, or select whose highlighted row drives this widget. + +## Parameters + + - `text`: Label text, or a closure over the source row. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Title and status around a table +```nu +> ls | tui label --title "files" | tui table | tui label --status "enter: pick q: quit" | tui run + +``` + +Inline text above a text box +```nu +> tui label "new name" | tui textbox | tui debug | get screen + +``` + +A label that follows the highlighted row +```nu +> ls | tui table | tui label {|row| $"size: ($row.size)" } | tui run + +``` + +## Notes +Without a flag the text is drawn where it appears in the layout. `--title` puts it on the one-line bar at the top (also used as the dialog title). `--status` puts it on the bottom bar, where live focus/filter/row hints are appended. + +A closure instead of text makes the label follow a list: it receives the highlighted row of `--from` (or the nearest table/tree/select) and its output is shown. \ No newline at end of file diff --git a/commands/docs/tui_log.md b/commands/docs/tui_log.md new file mode 100644 index 00000000000..855f4d16452 --- /dev/null +++ b/commands/docs/tui_log.md @@ -0,0 +1,58 @@ +--- +title: tui log +categories: | + viewers +version: 0.116.0 +viewers: | + Add an append-only log view. Streamed rows appear at the bottom. +usage: | + Add an append-only log view. Streamed rows appear at the bottom. +editLink: false +contributors: false +--- + + +# `tui log` for [viewers](/commands/categories/viewers.md) + +
Add an append-only log view. Streamed rows appear at the bottom.
+ +## Command Type + +`built-in` + +## Signature + +```> tui log {flags} (source)``` + +## Flags + + - `--max-lines {int}`: Keep only the last N lines (default 10000). + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + - `--data {any}`: Data for this widget alone, instead of the outer pipeline's. + - `--from {string}`: Id of the table, tree, or select whose highlighted row drives this widget. + +## Parameters + + - `source`: Closure over the source row whose output is shown. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Live log of a slow stream +```nu +> 1.. | each {|n| sleep 100ms; $"tick ($n)"} | tui label --title "ticks" | tui log | tui run + +``` + +## Notes +Follows the tail as new items arrive. Mouse wheel and Up/Down scroll; scrolling up pauses follow until you hit the bottom again. `--max-lines` keeps that many newest lines in the view. Streamed rows share a global store capped at max(10000, --max-lines). + +With `--from` and a closure the log shows the closure's output for the highlighted row of another widget, e.g. `tui log --from table-0 {|row| open $row.name | lines }`. \ No newline at end of file diff --git a/commands/docs/tui_menu.md b/commands/docs/tui_menu.md new file mode 100644 index 00000000000..0fc67edd6d1 --- /dev/null +++ b/commands/docs/tui_menu.md @@ -0,0 +1,65 @@ +--- +title: tui menu +categories: | + viewers +version: 0.116.0 +viewers: | + Add a menu bar with mnemonics, dropdown items, and actions. +usage: | + Add a menu bar with mnemonics, dropdown items, and actions. +editLink: false +contributors: false +--- + + +# `tui menu` for [viewers](/commands/categories/viewers.md) + +
Add a menu bar with mnemonics, dropdown items, and actions.
+ +## Command Type + +`built-in` + +## Signature + +```> tui menu {flags} (items)``` + +## Flags + + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + +## Parameters + + - `items`: Bar entries: strings or {name, items?, action?} records. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +A plain bar; Enter submits the item name +```nu +> tui label --title "Editor" | tui menu ["&File" "&Edit" "&View"] | tui table | tui debug --keys "alt+e,enter" | get selected + +``` + +Dropdowns with actions that reload the table, and a Quit entry that submits +```nu +> ls | tui menu [{name: "&File", items: [{name: "&Reload", action: {|| ls }} "&Quit"]} {name: "&View", items: [{name: "&Sizes", action: {|| ls | sort-by size }}]}] | tui table | tui run + +``` + +## Notes +Each entry is a string, or a record `{name, items?, action?}`. `items` is a list of the same shape and opens as a dropdown; `action` is a hook closure. + +Mnemonics: `&` before a letter in a name picks it (`"&File"` shows as File with F underlined); otherwise the first letter is used. Alt+letter opens that bar item from anywhere except a text field. Inside an open dropdown, the letter alone picks the item. Left/Right (or h/l) move along the bar, Down/Enter open a dropdown, Up/Down move inside it, Esc closes it. + +Activating an item with an `action` runs it as a hook: it receives the state record, a returned value replaces the data list, `{action: submit|quit}` ends the TUI, and an error goes to the status bar. Activating an item without an action submits it: `selected` is `{menu: "File", item: "Open", row: }` for a dropdown entry, or the bar item's name. + +The menu is top-level chrome and cannot be nested in `tui split` or `tui box`. \ No newline at end of file diff --git a/commands/docs/tui_preview.md b/commands/docs/tui_preview.md new file mode 100644 index 00000000000..1a0da2644ee --- /dev/null +++ b/commands/docs/tui_preview.md @@ -0,0 +1,67 @@ +--- +title: tui preview +categories: | + viewers +version: 0.116.0 +viewers: | + Show text for the selected table, tree, or select row. Arrow keys stay on the source. +usage: | + Show text for the selected table, tree, or select row. Arrow keys stay on the source. +editLink: false +contributors: false +--- + + +# `tui preview` for [viewers](/commands/categories/viewers.md) + +
Show text for the selected table, tree, or select row. Arrow keys stay on the source.
+ +## Command Type + +`built-in` + +## Signature + +```> tui preview {flags} (transform)``` + +## Flags + + - `--from {string}`: Table, tree, or select id to follow. + - `--max-bytes {int}`: Maximum bytes to read from a file (default 65536). + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + +## Parameters + + - `transform`: No parameters: transform file text (`$in`). One parameter: produce text from the row. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +File list on the left, highlighted contents on the right +```nu +> ls | tui split [(tui table) (tui preview { nu-highlight })] | tui run + +``` + +Preview a value from the row instead of a file +```nu +> $env.config.keybindings | tui split [(tui table) (tui preview {|row| $row.event | to nuon })] | tui run + +``` + +## Notes +Without a closure, the row's `name` (or the row itself when it is a string) is read as a file path, up to `--max-bytes`. Directories and binary files show a short note. + +A closure with no parameters transforms that file text: it receives the contents as `$in`, with `content_type` in pipeline metadata, so `{ nu-highlight }` colors source files. + +A closure with one parameter is the source: it receives the selected row and whatever it returns is shown. Nothing is read from disk, so any column or computed value can be previewed: `{|row| $row.event | to nuon }` or `{|row| open --raw $row.path }`. + +The preview follows the focused list, else the nearest one in the same container. `--from` names one explicitly. \ No newline at end of file diff --git a/commands/docs/tui_progress.md b/commands/docs/tui_progress.md new file mode 100644 index 00000000000..002179220c4 --- /dev/null +++ b/commands/docs/tui_progress.md @@ -0,0 +1,66 @@ +--- +title: tui progress +categories: | + viewers +version: 0.116.0 +viewers: | + Add a progress bar. +usage: | + Add a progress bar. +editLink: false +contributors: false +--- + + +# `tui progress` for [viewers](/commands/categories/viewers.md) + +
Add a progress bar.
+ +## Command Type + +`built-in` + +## Signature + +```> tui progress {flags} (source)``` + +## Flags + + - `--value, -v {number}`: Fixed value to show. + - `--total, -t {number}`: Value that fills the bar (default 1, or 100 for values above 1). + - `--label, -l {string}`: Text before the percentage. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + - `--data {any}`: Data for this widget alone, instead of the outer pipeline's. + - `--from {string}`: Id of the table, tree, or select whose highlighted row drives this widget. + +## Parameters + + - `source`: Closure over the --from row that yields the value. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +A static bar at 40% +```nu +> tui progress --value 0.4 --label copying | tui debug | get screen + +``` + +A bar driven by a stream +```nu +> 1..100 | each {|n| sleep 50ms; $n } | tui progress --total 100 | tui run + +``` + +## Notes +The bar shows `--value`, or otherwise reads its data: a number, a `{value, total}` record's `value`, or the last number in a list, so a streamed counter drives it live. Values above 1 are read out of `--total` (default 100). + +With `--from` and a closure the bar follows another widget's highlighted row: `tui progress --from table-0 {|row| $row.pct }`. \ No newline at end of file diff --git a/commands/docs/tui_run.md b/commands/docs/tui_run.md new file mode 100644 index 00000000000..c877a877aaf --- /dev/null +++ b/commands/docs/tui_run.md @@ -0,0 +1,81 @@ +--- +title: tui run +categories: | + viewers +version: 0.116.0 +viewers: | + Run a composed TUI until the user quits or submits a selection. +usage: | + Run a composed TUI until the user quits or submits a selection. +editLink: false +contributors: false +--- + + +# `tui run` for [viewers](/commands/categories/viewers.md) + +
Run a composed TUI until the user quits or submits a selection.
+ +## Command Type + +`built-in` + +## Signature + +```> tui run {flags} (hook)``` + +## Flags + + - `--dialog, -d`: Show a floating, draggable, resizable popup on the alternate screen. + - `--size, -s {list}`: Popup [width height] with --dialog. Default: 3/4 of the terminal. + - `--refresh, -r {duration}`: How often to re-run the hook (e.g. 1sec). + - `--no-mouse`: Disable mouse capture. + +## Parameters + + - `hook`: Hook whose output replaces the data list. Used with --refresh. + + +## Input/output types: + +| input | output | +| ----- | ------ | +| tui | record | +| any | record | +## Examples + +Pick a file +```nu +> ls | tui label --title "files" | tui table | tui run | get selected.name + +``` + +Refresh a file list every second, in a popup +```nu +> ls | tui table | tui run --dialog --refresh 1sec { ls } + +``` + +Read a text box by id after submit +```nu +> tui textbox --id name | tui run | get values.name + +``` + +## Notes +Interactive keys: +- Tab / Shift+Tab: move focus between widgets +- [ / ] or Ctrl+Tab: switch tabs; 1-9: jump to a tab +- Arrows, hjkl, PageUp/PageDown, Home/End: move in lists; scroll logs +- Space: check a row in a --multi list +- Type in a focused search box or text box; q is a character there +- Mouse: click to focus/select, scroll, drag split handles and dialog chrome +- Enter: submit the focused widget's selection and return a record +- q / Esc (when not typing) or Ctrl+C: quit + +The result is `{action, focused, selected, page, values, rows, live}`. `action` is `submit` or `quit`; `selected` is the focused widget's selection (a table row, checked rows with --multi, a text box's text, ...); `values` holds every widget's state by id, e.g. `values.table-0.index`. + +A closure runs as a hook with the state record as `$in`: its output replaces the data list, `{action: submit, selected: ...}` ends the TUI, `null` does nothing. `--refresh 1sec { ls }` re-runs it on that interval; without `--refresh` it runs once at start. +`--dialog` opens a floating popup on the alternate screen; `--size [70 20]` sets its size. + +To render without a terminal, or to replay keys in a test, use `tui debug`. \ No newline at end of file diff --git a/commands/docs/tui_search.md b/commands/docs/tui_search.md new file mode 100644 index 00000000000..5375cc9c4ac --- /dev/null +++ b/commands/docs/tui_search.md @@ -0,0 +1,64 @@ +--- +title: tui search +categories: | + viewers +version: 0.116.0 +viewers: | + Add a search box that filters tables, logs, trees, and selects as you type. +usage: | + Add a search box that filters tables, logs, trees, and selects as you type. +editLink: false +contributors: false +--- + + +# `tui search` for [viewers](/commands/categories/viewers.md) + +
Add a search box that filters tables, logs, trees, and selects as you type.
+ +## Command Type + +`built-in` + +## Signature + +```> tui search {flags} ``` + +## Flags + + - `--placeholder {string}`: Placeholder text. + - `--bind {string}`: Key that focuses search, for example '/' or 'ctrl+r'. + - `--fuzzy, -f`: Fuzzy matching instead of substring. + - `--case-sensitive, -s`: Respect case when matching. + - `--columns {list}`: Match only these record columns. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Filter a table from a search box +```nu +> [{name: alpha},{name: beta}] | tui search --placeholder "filter" --bind / | tui table | tui debug --keys "/,type:be,tab,enter" | get selected.name + +``` + +Fuzzy match on one column +```nu +> [{name: alpha},{name: gamma}] | tui search --fuzzy --columns [name] | tui table | tui debug --keys "tab,type:gm,enter" | get selected.name + +``` + +## Notes +`--bind` focuses this search box from anywhere except a text field (for example `--bind /` or `--bind ctrl+r`). Esc clears the query; Esc again leaves the box. Enter submits the highlighted row of the list it filters. + +Matching is a case-insensitive substring over every field by default. `--fuzzy` uses the same matcher as `input list --fuzzy`, `--case-sensitive` respects case, and `--columns [name]` matches only those columns. + +Scope comes from position: a search box in the outer pipeline filters every list; one placed inside `tui split [...]` or `tui box "name" [...]` filters only the widgets in that container. \ No newline at end of file diff --git a/commands/docs/tui_select.md b/commands/docs/tui_select.md new file mode 100644 index 00000000000..73309257f33 --- /dev/null +++ b/commands/docs/tui_select.md @@ -0,0 +1,67 @@ +--- +title: tui select +categories: | + viewers +version: 0.116.0 +viewers: | + Add a radio list of items, or a checkbox list with --multi. +usage: | + Add a radio list of items, or a checkbox list with --multi. +editLink: false +contributors: false +--- + + +# `tui select` for [viewers](/commands/categories/viewers.md) + +
Add a radio list of items, or a checkbox list with --multi.
+ +## Command Type + +`built-in` + +## Signature + +```> tui select {flags} (items)``` + +## Flags + + - `--display, -d {oneof}`: Column or closure that produces each item's label. + - `--index, -i`: Select item indexes instead of items. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + - `--data {any}`: Data for this widget alone, instead of the outer pipeline's. + - `--from {string}`: Id of the table, tree, or select whose highlighted row drives this widget. + - `--on-select {closure(any)}`: Hook run when the highlighted row changes; receives the state record. + - `--multi, -m`: Space toggles rows; the selection is the checked rows. + +## Parameters + + - `items`: Items to choose from. Defaults to the widget's data rows. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Pick one of three options +```nu +> tui select [small medium large] | tui debug --keys [down enter] | get selected + +``` + +Check several files by name +```nu +> ls | tui select --multi --display name | tui run | get selected.name + +``` + +## Notes +Items come from the list argument, from `--data`, or from the pipeline. Up/Down move, Space checks (with `--multi`), Enter submits the chosen item(s); `--index` submits positions instead. + +`--display` picks the text shown for each item: a column name for records, or a closure over the item. The original item is what gets selected, as with `input list --display`. \ No newline at end of file diff --git a/commands/docs/tui_split.md b/commands/docs/tui_split.md new file mode 100644 index 00000000000..75fd115ba1c --- /dev/null +++ b/commands/docs/tui_split.md @@ -0,0 +1,70 @@ +--- +title: tui split +categories: | + viewers +version: 0.116.0 +viewers: | + Lay out child widgets side by side (or stacked with --vertical) with draggable dividers. +usage: | + Lay out child widgets side by side (or stacked with --vertical) with draggable dividers. +editLink: false +contributors: false +--- + + +# `tui split` for [viewers](/commands/categories/viewers.md) + +
Lay out child widgets side by side (or stacked with --vertical) with draggable dividers.
+ +## Command Type + +`built-in` + +## Signature + +```> tui split {flags} (children)``` + +## Flags + + - `--vertical, -v`: Stack children top to bottom. + - `--sizes, -s {list}`: One size per child: cells, "30%", "1fr", "min:N", "max:N". + - `--ratio, -r {int}`: Percent of space for the first child; the rest share the remainder. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + +## Parameters + + - `children`: Widgets to arrange, e.g. [(tui table) (tui preview)]. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Table on the left, file preview on the right +```nu +> ls | tui split --sizes [40% 1fr] [(tui table --columns [name size]) (tui preview)] | tui run + +``` + +A fixed 30-cell sidebar +```nu +> ls | tui split --sizes [30 1fr] [(tui tree --walk) (tui preview)] | tui run + +``` + +Two tables with their own rows +```nu +> tui split [(ls | tui table) (ps | tui table)] | tui run + +``` + +## Notes +Children are `tui` values built in parentheses: `tui split [(tui table) (tui preview)]`. A child can carry its own rows: `[(ls | tui table) (ps | tui table)]`. Splits nest. + +`--sizes` gives one size per child: an int is cells (`20`), `"30%"` a share of the split, `"1fr"` a share of what is left (`"2fr"` twice as much), `"min:10"` / `"max:40"` bounds. Missing entries are `1fr`. `--ratio 60` is shorthand for `--sizes [60% 1fr]`. Drag a divider with the mouse, or Tab to the split and use arrows/hjkl for 1% steps. \ No newline at end of file diff --git a/commands/docs/tui_tab.md b/commands/docs/tui_tab.md new file mode 100644 index 00000000000..c5de2ddf000 --- /dev/null +++ b/commands/docs/tui_tab.md @@ -0,0 +1,58 @@ +--- +title: tui tab +categories: | + viewers +version: 0.116.0 +viewers: | + Group widgets as a page in the tab bar. +usage: | + Group widgets as a page in the tab bar. +editLink: false +contributors: false +--- + + +# `tui tab` for [viewers](/commands/categories/viewers.md) + +
Group widgets as a page in the tab bar.
+ +## Command Type + +`built-in` + +## Signature + +```> tui tab {flags} (title) (children)``` + +## Flags + + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + +## Parameters + + - `title`: Tab title. + - `children`: Widgets on this tab, e.g. [(tui table) (tui preview)]. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +The same rows as a table and as a tree, on two tabs +```nu +> ls | tui tab "table" [(tui table)] | tui tab "tree" [(tui tree --walk)] | tui run + +``` + +## Notes +Each `tui tab` in the outer pipeline is a page and the tab bar shows whenever any exists. Click a tab, press 1-9, or use `[` `]` / Ctrl+Tab to switch. Chrome (title, menu, search, status) stays visible on every page. + +Tabs cannot be nested; for a titled box inside a split use `tui box`. + +Children are `tui` values built in parentheses: `tui tab "files" [(tui table) (tui preview)]`. \ No newline at end of file diff --git a/commands/docs/tui_table.md b/commands/docs/tui_table.md new file mode 100644 index 00000000000..940e13403d3 --- /dev/null +++ b/commands/docs/tui_table.md @@ -0,0 +1,82 @@ +--- +title: tui table +categories: | + viewers +version: 0.116.0 +viewers: | + Add a navigable table. Pipeline rows become the rows; scalars show as one `item` column. +usage: | + Add a navigable table. Pipeline rows become the rows; scalars show as one `item` column. +editLink: false +contributors: false +--- + + +# `tui table` for [viewers](/commands/categories/viewers.md) + +
Add a navigable table. Pipeline rows become the rows; scalars show as one `item` column.
+ +## Command Type + +`built-in` + +## Signature + +```> tui table {flags} (source)``` + +## Flags + + - `--columns {list}`: Columns to show. Defaults to the columns of the input table. + - `--capture-keys`: A chord pressed on the focused table becomes the filter query. + - `--index, -i`: Select row indexes instead of rows. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + - `--data {any}`: Data for this widget alone, instead of the outer pipeline's. + - `--from {string}`: Id of the table, tree, or select whose highlighted row drives this widget. + - `--on-select {closure(any)}`: Hook run when the highlighted row changes; receives the state record. + - `--multi, -m`: Space toggles rows; the selection is the checked rows. + +## Parameters + + - `source`: Closure over the --from row whose output is this table's rows. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Show a small table and pick a row +```nu +> [{name: foo, size: 1}, {name: bar, size: 2}] | tui table --columns [name size] | tui debug --keys down,enter | get selected.name + +``` + +Check several rows and submit them +```nu +> [a b c] | tui table --multi | tui debug --keys [space down space enter] | get selected + +``` + +A detail table driven by a tree +```nu +> ls | tui split [(tui tree --walk) (tui table --from tree-0 {|node| ls $node.name })] | tui run + +``` + +Keybinding explorer: press a chord to filter +```nu +> $env.config.keybindings | tui table --capture-keys --columns [name modifier keycode] | tui run + +``` + +## Notes +Up/Down, j/k, PageUp/PageDown, Home/End, and mouse wheel move the selection. Enter submits the current row (`--index` submits its index). With `--multi`, Space checks rows and the selection is the checked rows. A `tui search` widget filters rows as you type. Streams append while the TUI runs (oldest rows drop after 10,000). + +`--data` gives this table its own rows; `--from ` with a closure makes it a detail view of another widget's highlighted row: `tui table --from tree-0 {|node| ls $node.name }`. `--on-select` runs a hook whenever the highlight moves. + +`--capture-keys` turns a chord pressed on the focused table (for example Ctrl+R) into the filter query, so a keybinding table filters to bindings that match that chord. Rows with `modifier`/`keycode` fields match reedline-style chords. \ No newline at end of file diff --git a/commands/docs/tui_textbox.md b/commands/docs/tui_textbox.md new file mode 100644 index 00000000000..8e78d351616 --- /dev/null +++ b/commands/docs/tui_textbox.md @@ -0,0 +1,51 @@ +--- +title: tui textbox +categories: | + viewers +version: 0.116.0 +viewers: | + Add an editable text field. Tab to focus it, then type. +usage: | + Add an editable text field. Tab to focus it, then type. +editLink: false +contributors: false +--- + + +# `tui textbox` for [viewers](/commands/categories/viewers.md) + +
Add an editable text field. Tab to focus it, then type.
+ +## Command Type + +`built-in` + +## Signature + +```> tui textbox {flags} ``` + +## Flags + + - `--placeholder {string}`: Shown when empty. + - `--value {string}`: Initial text. + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Type into a text box and submit (headless) +```nu +> tui textbox --placeholder "name" | tui debug --keys "type:Ada,enter" | get selected + +``` + +## Notes +While focused, q is a character, Esc leaves the field, Enter submits the TUI with the text as `selected`. The text is also returned under `values` keyed by widget id. \ No newline at end of file diff --git a/commands/docs/tui_tree.md b/commands/docs/tui_tree.md new file mode 100644 index 00000000000..4a1c9e5b89c --- /dev/null +++ b/commands/docs/tui_tree.md @@ -0,0 +1,65 @@ +--- +title: tui tree +categories: | + viewers +version: 0.116.0 +viewers: | + Add a tree for nested records or a directory walk. +usage: | + Add a tree for nested records or a directory walk. +editLink: false +contributors: false +--- + + +# `tui tree` for [viewers](/commands/categories/viewers.md) + +
Add a tree for nested records or a directory walk.
+ +## Command Type + +`built-in` + +## Signature + +```> tui tree {flags} (source)``` + +## Flags + + - `--walk`: Expand directories on disk when a node is opened. + - `--column {string}`: Path/name column (default name). + - `--id {string}`: Widget id. + - `--focus`: Start with this widget focused. + - `--data {any}`: Data for this widget alone, instead of the outer pipeline's. + - `--from {string}`: Id of the table, tree, or select whose highlighted row drives this widget. + - `--on-select {closure(any)}`: Hook run when the highlighted row changes; receives the state record. + - `--multi, -m`: Space toggles rows; the selection is the checked rows. + +## Parameters + + - `source`: Closure over the --from row whose output is this tree's data. + + +## Input/output types: + +| input | output | +| ------- | ------ | +| nothing | tui | +| tui | tui | +| any | tui | +## Examples + +Nested record as a tree +```nu +> {a: {b: 1, c: 2}, d: [3, 4]} | tui tree | tui debug | get screen + +``` + +Directory walk next to a preview +```nu +> ls | tui split [(tui tree --walk) (tui preview)] | tui run + +``` + +## Notes +Up/Down move. Right or l expands, Left or h collapses. Enter submits the selected node; with `--multi`, Space checks nodes. `--walk` treats `type == dir` rows as folders and lists them on expand; `--column` names the path column for that walk. A `tui preview` or a `--from` widget next to this tree follows the selected node. \ No newline at end of file diff --git a/commands/docs/tutor.md b/commands/docs/tutor.md index 2d0c31c65d2..4766d836a4b 100644 --- a/commands/docs/tutor.md +++ b/commands/docs/tutor.md @@ -2,7 +2,7 @@ title: tutor categories: | misc -version: 0.115.1 +version: 0.116.0 misc: | Run the tutorial. To begin, run: tutor. usage: | diff --git a/commands/docs/ulimit.md b/commands/docs/ulimit.md index 6b883f24116..924af65177c 100644 --- a/commands/docs/ulimit.md +++ b/commands/docs/ulimit.md @@ -2,7 +2,7 @@ title: ulimit categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Set or get resource usage limits. usage: | diff --git a/commands/docs/umask.md b/commands/docs/umask.md index 341544cb4df..726d507fa33 100644 --- a/commands/docs/umask.md +++ b/commands/docs/umask.md @@ -2,7 +2,7 @@ title: umask categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Get or set default file creation permissions. usage: | diff --git a/commands/docs/uname.md b/commands/docs/uname.md index 9775c15a938..aa358562ad0 100644 --- a/commands/docs/uname.md +++ b/commands/docs/uname.md @@ -2,7 +2,7 @@ title: uname categories: | system -version: 0.115.1 +version: 0.116.0 system: | Print certain system information using uutils/coreutils uname. usage: | diff --git a/commands/docs/union.md b/commands/docs/union.md index 4bdb560b5f0..bf5337ccf47 100644 --- a/commands/docs/union.md +++ b/commands/docs/union.md @@ -2,7 +2,7 @@ title: union categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Returns a list of unique elements from both the input and the provided list. usage: | diff --git a/commands/docs/uniq-by.md b/commands/docs/uniq-by.md index e41e4984d2f..254396886ca 100644 --- a/commands/docs/uniq-by.md +++ b/commands/docs/uniq-by.md @@ -2,7 +2,7 @@ title: uniq-by categories: | filters -version: 0.115.1 +version: 0.116.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 08db534440f..97d1ee5ccb7 100644 --- a/commands/docs/uniq.md +++ b/commands/docs/uniq.md @@ -2,7 +2,7 @@ title: uniq categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Return the distinct values in the input. usage: | diff --git a/commands/docs/unlet.md b/commands/docs/unlet.md index 565e3b051f3..7b2398695f0 100644 --- a/commands/docs/unlet.md +++ b/commands/docs/unlet.md @@ -2,7 +2,7 @@ title: unlet categories: | experimental -version: 0.115.1 +version: 0.116.0 experimental: | Delete variables from nushell memory, making them unrecoverable. usage: | diff --git a/commands/docs/update.md b/commands/docs/update.md index 682af35fec8..30aea955d34 100644 --- a/commands/docs/update.md +++ b/commands/docs/update.md @@ -2,7 +2,7 @@ title: update categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Update an existing column to have a new value. usage: | diff --git a/commands/docs/update_cells.md b/commands/docs/update_cells.md index 73a8bd65702..03de44ca7ce 100644 --- a/commands/docs/update_cells.md +++ b/commands/docs/update_cells.md @@ -2,7 +2,7 @@ title: update cells categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Update the table cells. usage: | @@ -27,6 +27,7 @@ contributors: false ## Flags - `--columns, -c {list}`: List of columns to update. + - `--recursive, -r`: Descend into nested records and lists, running the closure on every leaf value. ## Parameters @@ -90,3 +91,22 @@ Update each value in a record. │ c │ 13 │ ╰───┴────╯ ``` + +Update every leaf value in a nested record. +```nu +> {a: 1, b: {c: 2, d: [3, 4]}} | update cells --recursive { $in * 10 } +╭───┬────────────────────╮ +│ a │ 10 │ +│ │ ╭───┬────────────╮ │ +│ b │ │ c │ 20 │ │ +│ │ │ │ ╭───┬────╮ │ │ +│ │ │ d │ │ 0 │ 30 │ │ │ +│ │ │ │ │ 1 │ 40 │ │ │ +│ │ │ │ ╰───┴────╯ │ │ +│ │ ╰───┴────────────╯ │ +╰───┴────────────────────╯ +``` + +## Notes +By default the closure runs once per cell, so a cell holding a record or list is passed to the closure whole. +With `--recursive`, nested records and lists are descended into instead and the closure runs on each leaf value inside them. \ No newline at end of file diff --git a/commands/docs/upsert.md b/commands/docs/upsert.md index b2bcc8d9a98..712517d4dd6 100644 --- a/commands/docs/upsert.md +++ b/commands/docs/upsert.md @@ -2,7 +2,7 @@ title: upsert categories: | filters -version: 0.115.1 +version: 0.116.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 6f0c6cb2f49..d642701ad2c 100644 --- a/commands/docs/url.md +++ b/commands/docs/url.md @@ -2,7 +2,7 @@ title: url categories: | network -version: 0.115.1 +version: 0.116.0 network: | Various commands for working with URLs. usage: | diff --git a/commands/docs/url_build-query.md b/commands/docs/url_build-query.md index ffedd7b9a97..a5b4ec9e913 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.115.1 +version: 0.116.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 7e14dbf200a..fae88cfad8f 100644 --- a/commands/docs/url_decode.md +++ b/commands/docs/url_decode.md @@ -2,7 +2,7 @@ title: url decode categories: | strings -version: 0.115.1 +version: 0.116.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 3913a8d8f4a..1408500cee7 100644 --- a/commands/docs/url_encode.md +++ b/commands/docs/url_encode.md @@ -2,7 +2,7 @@ title: url encode categories: | strings -version: 0.115.1 +version: 0.116.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 27512003763..2cb16afa0c9 100644 --- a/commands/docs/url_join.md +++ b/commands/docs/url_join.md @@ -2,7 +2,7 @@ title: url join categories: | network -version: 0.115.1 +version: 0.116.0 network: | Convert a record to a URL string. usage: | diff --git a/commands/docs/url_parse.md b/commands/docs/url_parse.md index dbf20c549f9..673484e152f 100644 --- a/commands/docs/url_parse.md +++ b/commands/docs/url_parse.md @@ -2,7 +2,7 @@ title: url parse categories: | network -version: 0.115.1 +version: 0.116.0 network: | Parse a URL string into structured data. usage: | diff --git a/commands/docs/url_split-query.md b/commands/docs/url_split-query.md index 9b9059b87c0..9418702417d 100644 --- a/commands/docs/url_split-query.md +++ b/commands/docs/url_split-query.md @@ -2,7 +2,7 @@ title: url split-query categories: | network -version: 0.115.1 +version: 0.116.0 network: | Converts query string into table applying percent-decoding. usage: | diff --git a/commands/docs/use.md b/commands/docs/use.md index 9c10eaed21a..5a7ab785b18 100644 --- a/commands/docs/use.md +++ b/commands/docs/use.md @@ -2,7 +2,7 @@ title: use categories: | core -version: 0.115.1 +version: 0.116.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 aa39cc820ec..e70db6294d1 100644 --- a/commands/docs/values.md +++ b/commands/docs/values.md @@ -2,7 +2,7 @@ title: values categories: | filters -version: 0.115.1 +version: 0.116.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 89f3f7b7ab5..1fc00b0a9e5 100644 --- a/commands/docs/version.md +++ b/commands/docs/version.md @@ -2,7 +2,7 @@ title: version categories: | core -version: 0.115.1 +version: 0.116.0 core: | Display Nu version, and its build configuration. usage: | diff --git a/commands/docs/version_check.md b/commands/docs/version_check.md index 586f63d61ac..8241a079de0 100644 --- a/commands/docs/version_check.md +++ b/commands/docs/version_check.md @@ -2,7 +2,7 @@ title: version check categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Checks to see if you have the latest version of nushell. usage: | diff --git a/commands/docs/view.md b/commands/docs/view.md index 4d53569bb0e..29a50d3f61c 100644 --- a/commands/docs/view.md +++ b/commands/docs/view.md @@ -2,7 +2,7 @@ title: view categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | Various commands for viewing debug information. usage: | diff --git a/commands/docs/view_blocks.md b/commands/docs/view_blocks.md index d4735a5e611..b75a8ee80a1 100644 --- a/commands/docs/view_blocks.md +++ b/commands/docs/view_blocks.md @@ -2,7 +2,7 @@ title: view blocks categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | View the blocks registered in nushell's EngineState memory. usage: | diff --git a/commands/docs/view_files.md b/commands/docs/view_files.md index 7809511481e..ed59acedfbb 100644 --- a/commands/docs/view_files.md +++ b/commands/docs/view_files.md @@ -2,7 +2,7 @@ title: view files categories: | debug -version: 0.115.1 +version: 0.116.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 c5d873c2d00..380ddb128ab 100644 --- a/commands/docs/view_ir.md +++ b/commands/docs/view_ir.md @@ -2,7 +2,7 @@ title: view ir categories: | debug -version: 0.115.1 +version: 0.116.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 fb79609a517..9e92f00d57e 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -2,7 +2,7 @@ title: view source categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | View a block, module, or a definition. usage: | @@ -24,6 +24,10 @@ contributors: false ```> view source {flags} (item)``` +## Flags + + - `--dependencies, -d`: Also show every custom command the item calls, transitively, and every constant those bodies read. + ## Parameters - `item`: Name or block to view. @@ -78,8 +82,33 @@ View the source of an alias. echo hi ``` +View a command together with the commands it calls. +```nu +> def helper [] { 42 }; def caller [] { helper }; view source caller --dependencies +def caller [] { helper } + +def helper [] { 42 } +``` + View the file where a definition lives via metadata. ```nu > view source some_command | metadata ``` + +## Notes +The `def` header is rebuilt from the signature instead of being quoted from +the source, so `export` and attributes are lost. That holds with or without +`--dependencies`. + +`--dependencies` applies to a custom command; on an alias, a module, a +closure or a block id it does nothing. It follows only the calls the parser +can see, so a closure written inside the body is followed even when it is run +through a variable, but one that arrives as an argument is not. And a command +built on a large module can pull in a lot of output. + +A constant is rebuilt the same way, as `const = `, because only +the name is recorded with a source span. So the value is the one the command +actually reads: an expression such as `path self` shows up already resolved, +and an explicit type annotation is lost. `$nu` and the record bound by `use +` are left out — neither is written as a `const` anywhere. \ No newline at end of file diff --git a/commands/docs/view_span.md b/commands/docs/view_span.md index 2aedc2ad4d8..b20961da3d4 100644 --- a/commands/docs/view_span.md +++ b/commands/docs/view_span.md @@ -2,7 +2,7 @@ title: view span categories: | debug -version: 0.115.1 +version: 0.116.0 debug: | View the contents of a span. usage: | diff --git a/commands/docs/watch.md b/commands/docs/watch.md index a9f928120fd..5b068f700e4 100644 --- a/commands/docs/watch.md +++ b/commands/docs/watch.md @@ -2,7 +2,7 @@ title: watch categories: | filesystem -version: 0.115.1 +version: 0.116.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 c574552b9c6..95da6f99eae 100644 --- a/commands/docs/where.md +++ b/commands/docs/where.md @@ -2,7 +2,7 @@ title: where categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Filter values of an input list based on a condition. usage: | diff --git a/commands/docs/which.md b/commands/docs/which.md index fa4e8fe3d0f..8cdd6b25969 100644 --- a/commands/docs/which.md +++ b/commands/docs/which.md @@ -2,7 +2,7 @@ title: which categories: | system -version: 0.115.1 +version: 0.116.0 system: | Finds a program file, alias or custom command. If `application` is not provided, all deduplicated commands will be returned. usage: | diff --git a/commands/docs/while.md b/commands/docs/while.md index 81d9ce28cab..59af6e5f6eb 100644 --- a/commands/docs/while.md +++ b/commands/docs/while.md @@ -2,7 +2,7 @@ title: while categories: | core -version: 0.115.1 +version: 0.116.0 core: | Conditionally run a block in a loop. usage: | diff --git a/commands/docs/whoami.md b/commands/docs/whoami.md index 92908f18037..b13de9a7c46 100644 --- a/commands/docs/whoami.md +++ b/commands/docs/whoami.md @@ -2,7 +2,7 @@ title: whoami categories: | platform -version: 0.115.1 +version: 0.116.0 platform: | Get the current username using uutils/coreutils whoami. usage: | diff --git a/commands/docs/window.md b/commands/docs/window.md index ff9eec905dd..af870253c0c 100644 --- a/commands/docs/window.md +++ b/commands/docs/window.md @@ -2,7 +2,7 @@ title: window categories: | filters -version: 0.115.1 +version: 0.116.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 e48fc604758..eda5cbee18f 100644 --- a/commands/docs/with-env.md +++ b/commands/docs/with-env.md @@ -2,7 +2,7 @@ title: with-env categories: | env -version: 0.115.1 +version: 0.116.0 env: | Runs a block with an environment variable set. usage: | diff --git a/commands/docs/wrap.md b/commands/docs/wrap.md index 0ab82945e0f..efe634f9b34 100644 --- a/commands/docs/wrap.md +++ b/commands/docs/wrap.md @@ -2,7 +2,7 @@ title: wrap categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Wrap the value into a column. usage: | diff --git a/commands/docs/zip.md b/commands/docs/zip.md index 5c195f28591..b3afdf948cb 100644 --- a/commands/docs/zip.md +++ b/commands/docs/zip.md @@ -2,7 +2,7 @@ title: zip categories: | filters -version: 0.115.1 +version: 0.116.0 filters: | Combine a stream with the input. usage: | From 91e3d26d9441cee75127092f81e399a7c1fa7759 Mon Sep 17 00:00:00 2001 From: hustcer Date: Fri, 25 Sep 2026 11:31:45 +0800 Subject: [PATCH 2/2] fix release error of docs --- commands/docs/view_source.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/commands/docs/view_source.md b/commands/docs/view_source.md index 9e92f00d57e..9253896c86b 100644 --- a/commands/docs/view_source.md +++ b/commands/docs/view_source.md @@ -110,5 +110,5 @@ built on a large module can pull in a lot of output. A constant is rebuilt the same way, as `const = `, because only the name is recorded with a source span. So the value is the one the command actually reads: an expression such as `path self` shows up already resolved, -and an explicit type annotation is lost. `$nu` and the record bound by `use -` are left out — neither is written as a `const` anywhere. \ No newline at end of file +and an explicit type annotation is lost. `$nu` and the record bound by +`use ` are left out — neither is written as a `const` anywhere. \ No newline at end of file