From 8c0a2d3c15d733a0032583e7deec23f7f40a4936 Mon Sep 17 00:00:00 2001 From: JT <547158+jntrnr@users.noreply.github.com> Date: Sun, 13 Feb 2022 21:22:51 -0500 Subject: [PATCH] Auto-generate markdown command docs (#4451) * Finish updating * a couple improvements * Update renames * cleanup examples --- crates/nu-engine/src/eval.rs | 23 +++ docs/commands/README.md | 25 --- docs/commands/alias.md | 37 +--- docs/commands/all.md | 29 +-- docs/commands/ansi-strip.md | 20 -- docs/commands/ansi.md | 98 +++------ docs/commands/ansi_gradient.md | 42 ++++ docs/commands/ansi_strip.md | 23 +++ docs/commands/any.md | 29 +-- docs/commands/append.md | 110 ++-------- docs/commands/autoenv-trust.md | 25 --- docs/commands/autoenv-untrust.md | 25 --- docs/commands/autoenv.md | 34 ---- docs/commands/autoview.md | 59 ------ docs/commands/benchmark.md | 32 +-- docs/commands/binaryview.md | 14 -- docs/commands/build-string.md | 34 ++-- docs/commands/cal.md | 210 ++----------------- docs/commands/cd.md | 37 +--- docs/commands/char.md | 43 ++-- docs/commands/chart-bar.md | 17 -- docs/commands/chart-line.md | 17 -- docs/commands/chart.md | 15 -- docs/commands/clear.md | 22 +- docs/commands/clip.md | 22 -- docs/commands/collect.md | 23 +++ docs/commands/columns.md | 29 +++ docs/commands/compact.md | 46 ++--- docs/commands/config-clear.md | 17 -- docs/commands/config-get.md | 20 -- docs/commands/config-path.md | 17 -- docs/commands/config-remove.md | 20 -- docs/commands/config-set.md | 44 ---- docs/commands/config-set_into.md | 20 -- docs/commands/config.md | 53 ----- docs/commands/cp.md | 33 ++- docs/commands/dataframe.md | 12 ++ docs/commands/date-format.md | 26 --- docs/commands/date-humanize.md | 24 --- docs/commands/date-list-timezone.md | 22 -- docs/commands/date-now.md | 11 - docs/commands/date-to-table.md | 17 -- docs/commands/date-to-timezone.md | 32 --- docs/commands/date.md | 56 +---- docs/commands/date_format.md | 33 +++ docs/commands/date_humanize.md | 24 +++ docs/commands/date_list-timezone.md | 12 ++ docs/commands/date_now.md | 12 ++ docs/commands/date_to-table.md | 29 +++ docs/commands/date_to-timezone.md | 38 ++++ docs/commands/debug.md | 76 ++----- docs/commands/decode.md | 23 +++ docs/commands/def-env.md | 18 ++ docs/commands/def.md | 79 ++------ docs/commands/default.md | 43 ++-- docs/commands/describe.md | 24 ++- docs/commands/detect_columns.md | 17 ++ docs/commands/dfr.md | 12 ++ docs/commands/dfr_aggregate.md | 37 ++++ docs/commands/dfr_all-false.md | 26 +++ docs/commands/dfr_all-true.md | 26 +++ docs/commands/dfr_append.md | 31 +++ docs/commands/dfr_arg-max.md | 19 ++ docs/commands/dfr_arg-min.md | 19 ++ docs/commands/dfr_arg-sort.md | 28 +++ docs/commands/dfr_arg-true.md | 19 ++ docs/commands/dfr_arg-unique.md | 19 ++ docs/commands/dfr_column.md | 23 +++ docs/commands/dfr_concatenate.md | 24 +++ docs/commands/dfr_contains.md | 23 +++ docs/commands/dfr_count-null.md | 20 ++ docs/commands/dfr_count-unique.md | 19 ++ docs/commands/dfr_cumulative.md | 24 +++ docs/commands/dfr_describe.md | 19 ++ docs/commands/dfr_drop-nulls.md | 32 +++ docs/commands/dfr_drop.md | 23 +++ docs/commands/dfr_dtypes.md | 19 ++ docs/commands/dfr_filter-with.md | 24 +++ docs/commands/dfr_first.md | 23 +++ docs/commands/dfr_get-day.md | 21 ++ docs/commands/dfr_get-hour.md | 21 ++ docs/commands/dfr_get-minute.md | 21 ++ docs/commands/dfr_get-month.md | 21 ++ docs/commands/dfr_get-nanosecond.md | 21 ++ docs/commands/dfr_get-ordinal.md | 21 ++ docs/commands/dfr_get-second.md | 21 ++ docs/commands/dfr_get-week.md | 21 ++ docs/commands/dfr_get-weekday.md | 21 ++ docs/commands/dfr_get-year.md | 21 ++ docs/commands/dfr_get.md | 23 +++ docs/commands/dfr_group-by.md | 23 +++ docs/commands/dfr_is-duplicated.md | 19 ++ docs/commands/dfr_is-in.md | 24 +++ docs/commands/dfr_is-not-null.md | 21 ++ docs/commands/dfr_is-null.md | 21 ++ docs/commands/dfr_is-unique.md | 19 ++ docs/commands/dfr_join.md | 28 +++ docs/commands/dfr_last.md | 23 +++ docs/commands/dfr_melt.md | 26 +++ docs/commands/dfr_not.md | 19 ++ docs/commands/dfr_open.md | 28 +++ docs/commands/dfr_pivot.md | 25 +++ docs/commands/dfr_rename-col.md | 24 +++ docs/commands/dfr_rename.md | 23 +++ docs/commands/dfr_replace-all.md | 24 +++ docs/commands/dfr_replace.md | 24 +++ docs/commands/dfr_rolling.md | 29 +++ docs/commands/dfr_sample.md | 30 +++ docs/commands/dfr_set-with-idx.md | 26 +++ docs/commands/dfr_set.md | 26 +++ docs/commands/dfr_shape.md | 19 ++ docs/commands/dfr_shift.md | 23 +++ docs/commands/dfr_slice.md | 24 +++ docs/commands/dfr_sort.md | 29 +++ docs/commands/dfr_str-lengths.md | 19 ++ docs/commands/dfr_str-slice.md | 24 +++ docs/commands/dfr_strftime.md | 25 +++ docs/commands/dfr_take.md | 32 +++ docs/commands/dfr_to-csv.md | 30 +++ docs/commands/dfr_to-df.md | 34 ++++ docs/commands/dfr_to-dummies.md | 24 +++ docs/commands/dfr_to-lowercase.md | 19 ++ docs/commands/dfr_to-nu.md | 29 +++ docs/commands/dfr_to-parquet.md | 23 +++ docs/commands/dfr_to-uppercase.md | 19 ++ docs/commands/dfr_unique.md | 19 ++ docs/commands/dfr_value-counts.md | 19 ++ docs/commands/dfr_with-column.md | 24 +++ docs/commands/do.md | 40 ++-- docs/commands/drop-column.md | 20 -- docs/commands/drop.md | 39 ++-- docs/commands/drop_column.md | 16 ++ docs/commands/drop_nth.md | 44 ++++ docs/commands/du.md | 50 ++--- docs/commands/each-group.md | 21 -- docs/commands/each-window.md | 22 -- docs/commands/each.md | 44 ++-- docs/commands/each_group.md | 24 +++ docs/commands/each_window.md | 30 +++ docs/commands/echo.md | 30 ++- docs/commands/empty.md | 82 ++------ docs/commands/enter.md | 62 +----- docs/commands/env.md | 12 ++ docs/commands/error_make.md | 26 +++ docs/commands/every.md | 48 ++--- docs/commands/exec.md | 31 +-- docs/commands/exit.md | 39 ++-- docs/commands/export.md | 12 ++ docs/commands/export_def-env.md | 18 ++ docs/commands/export_def.md | 18 ++ docs/commands/export_env.md | 17 ++ docs/commands/extern.md | 17 ++ docs/commands/fetch.md | 52 ++--- docs/commands/find.md | 49 +++++ docs/commands/first.md | 41 ++-- docs/commands/flatten.md | 49 +++-- docs/commands/fmt.md | 19 ++ docs/commands/for.md | 40 ++-- docs/commands/format-filesize.md | 26 --- docs/commands/format.md | 41 ++-- docs/commands/from-bson.md | 11 - docs/commands/from-csv.md | 116 ----------- docs/commands/from-eml.md | 12 -- docs/commands/from-ics.md | 40 ---- docs/commands/from-ini.md | 27 --- docs/commands/from-json.md | 32 --- docs/commands/from-ods.md | 39 ---- docs/commands/from-sqlite.md | 11 - docs/commands/from-ssv.md | 14 -- docs/commands/from-toml.md | 23 --- docs/commands/from-tsv.md | 52 ----- docs/commands/from-url.md | 15 -- docs/commands/from-vcf.md | 37 ---- docs/commands/from-xlsx.md | 33 --- docs/commands/from-xml.md | 34 ---- docs/commands/from-yaml.md | 23 --- docs/commands/from-yml.md | 11 - docs/commands/from.md | 65 +----- docs/commands/from_csv.md | 39 ++++ docs/commands/from_eml.md | 36 ++++ docs/commands/from_ics.md | 20 ++ docs/commands/from_ini.md | 21 ++ docs/commands/from_json.md | 28 +++ docs/commands/from_ods.md | 28 +++ docs/commands/from_ssv.md | 32 +++ docs/commands/from_toml.md | 25 +++ docs/commands/from_tsv.md | 16 ++ docs/commands/from_url.md | 19 ++ docs/commands/from_vcf.md | 23 +++ docs/commands/from_xlsx.md | 28 +++ docs/commands/from_xml.md | 22 ++ docs/commands/from_yaml.md | 24 +++ docs/commands/from_yml.md | 12 ++ docs/commands/g.md | 16 ++ docs/commands/get.md | 71 +++---- docs/commands/git_checkout.md | 16 ++ docs/commands/git_push.md | 17 ++ docs/commands/grid.md | 18 ++ docs/commands/group-by-date.md | 21 -- docs/commands/group-by.md | 80 ++------ docs/commands/gstat.md | 16 ++ docs/commands/hash-base64.md | 34 ---- docs/commands/hash-md5.md | 25 --- docs/commands/hash.md | 22 +- docs/commands/hash_base64.md | 37 ++++ docs/commands/hash_md5.md | 28 +++ docs/commands/hash_sha256.md | 28 +++ docs/commands/headers.md | 29 ++- docs/commands/help.md | 102 ++++------ docs/commands/hide.md | 16 ++ docs/commands/histogram.md | 92 --------- docs/commands/history.md | 27 ++- docs/commands/if.md | 44 ++-- docs/commands/ignore.md | 19 ++ docs/commands/inc.md | 45 ++--- docs/commands/input.md | 24 +++ docs/commands/insert.md | 32 +-- docs/commands/into-binary.md | 57 ------ docs/commands/into-int.md | 45 ----- docs/commands/into-string.md | 51 ----- docs/commands/into.md | 20 +- docs/commands/into_binary.md | 48 +++++ docs/commands/into_bool.md | 43 ++++ docs/commands/into_datetime.md | 47 +++++ docs/commands/into_decimal.md | 33 +++ docs/commands/into_filesize.md | 43 ++++ docs/commands/into_int.md | 59 ++++++ docs/commands/into_string.md | 69 +++++++ docs/commands/keep-until.md | 14 -- docs/commands/keep-while.md | 14 -- docs/commands/keep.md | 37 ++-- docs/commands/keep_until.md | 23 +++ docs/commands/keep_while.md | 23 +++ docs/commands/keybindings.md | 12 ++ docs/commands/keybindings_default.md | 19 ++ docs/commands/keybindings_list.md | 37 ++++ docs/commands/keybindings_listen.md | 19 ++ docs/commands/kill.md | 43 ++-- docs/commands/last.md | 39 ++-- docs/commands/length.md | 70 +------ docs/commands/let-env.md | 21 +- docs/commands/let.md | 37 ++-- docs/commands/lines.md | 37 +--- docs/commands/load-env.md | 36 ++-- docs/commands/ls.md | 45 ++--- docs/commands/match.md | 19 -- docs/commands/math-abs.md | 17 -- docs/commands/math-avg.md | 17 -- docs/commands/math-ceil.md | 17 -- docs/commands/math-eval.md | 158 --------------- docs/commands/math-floor.md | 17 -- docs/commands/math-max.md | 17 -- docs/commands/math-median.md | 17 -- docs/commands/math-min.md | 17 -- docs/commands/math-mode.md | 17 -- docs/commands/math-product.md | 17 -- docs/commands/math-round.md | 23 --- docs/commands/math-sqrt.md | 17 -- docs/commands/math-stddev.md | 23 --- docs/commands/math-sum.md | 22 -- docs/commands/math-variance.md | 23 --- docs/commands/math.md | 236 +--------------------- docs/commands/math_abs.md | 19 ++ docs/commands/math_avg.md | 19 ++ docs/commands/math_ceil.md | 19 ++ docs/commands/math_eval.md | 23 +++ docs/commands/math_floor.md | 19 ++ docs/commands/math_max.md | 19 ++ docs/commands/math_median.md | 19 ++ docs/commands/math_min.md | 19 ++ docs/commands/math_mode.md | 19 ++ docs/commands/math_product.md | 19 ++ docs/commands/math_round.md | 28 +++ docs/commands/math_sqrt.md | 19 ++ docs/commands/math_stddev.md | 28 +++ docs/commands/math_sum.md | 24 +++ docs/commands/math_variance.md | 28 +++ docs/commands/merge.md | 34 ++-- docs/commands/metadata.md | 28 +++ docs/commands/mkdir.md | 26 +-- docs/commands/module.md | 17 ++ docs/commands/move.md | 45 +++-- docs/commands/mv.md | 36 +--- docs/commands/n.md | 17 +- docs/commands/nth.md | 79 +------- docs/commands/nu-highlight.md | 19 ++ docs/commands/open.md | 117 ++--------- docs/commands/p.md | 17 +- docs/commands/par-each.md | 24 +++ docs/commands/par-each_group.md | 24 +++ docs/commands/parse.md | 29 +-- docs/commands/path-basename.md | 26 --- docs/commands/path-dirname.md | 32 --- docs/commands/path-exists.md | 20 -- docs/commands/path-expand.md | 20 -- docs/commands/path-join.md | 34 ---- docs/commands/path-parse.md | 39 ---- docs/commands/path-relative-to.md | 30 --- docs/commands/path-split.md | 25 --- docs/commands/path-type.md | 20 -- docs/commands/path.md | 39 +--- docs/commands/path_basename.md | 34 ++++ docs/commands/path_dirname.md | 40 ++++ docs/commands/path_exists.md | 28 +++ docs/commands/path_expand.md | 34 ++++ docs/commands/path_join.md | 39 ++++ docs/commands/path_parse.md | 39 ++++ docs/commands/path_relative-to.md | 34 ++++ docs/commands/path_split.md | 28 +++ docs/commands/path_type.md | 28 +++ docs/commands/pivot.md | 73 +------ docs/commands/post.md | 20 -- docs/commands/prepend.md | 63 ++---- docs/commands/ps.md | 54 ++--- docs/commands/pwd.md | 27 --- docs/commands/query.md | 12 ++ docs/commands/query_json.md | 16 ++ docs/commands/query_web.md | 20 ++ docs/commands/query_xml.md | 16 ++ docs/commands/random-bool.md | 23 --- docs/commands/random-chars.md | 23 --- docs/commands/random-decimal.md | 35 ---- docs/commands/random-dice.md | 24 --- docs/commands/random-integer.md | 35 ---- docs/commands/random-uuid.md | 17 -- docs/commands/random.md | 132 +----------- docs/commands/random_bool.md | 28 +++ docs/commands/random_chars.md | 28 +++ docs/commands/random_decimal.md | 38 ++++ docs/commands/random_dice.md | 29 +++ docs/commands/random_integer.md | 38 ++++ docs/commands/random_uuid.md | 19 ++ docs/commands/range.md | 38 ++-- docs/commands/reduce.md | 55 ++--- docs/commands/register.md | 19 ++ docs/commands/reject.md | 50 +---- docs/commands/rename.md | 39 +++- docs/commands/reverse.md | 62 ++---- docs/commands/rm.md | 48 ++--- docs/commands/roll-column.md | 16 -- docs/commands/roll-up.md | 14 -- docs/commands/roll.md | 22 +- docs/commands/roll_down.md | 23 +++ docs/commands/roll_left.md | 29 +++ docs/commands/roll_right.md | 29 +++ docs/commands/roll_up.md | 23 +++ docs/commands/rotate-counter-clockwise.md | 14 -- docs/commands/rotate.md | 54 ++++- docs/commands/run_external.md | 17 ++ docs/commands/s3.md | 19 -- docs/commands/save.md | 35 +--- docs/commands/select.md | 65 ++---- docs/commands/selector.md | 15 -- docs/commands/seq-date.md | 50 ----- docs/commands/seq.md | 46 ++--- docs/commands/seq_date.md | 55 +++++ docs/commands/shells.md | 30 +-- docs/commands/shuffle.md | 41 +--- docs/commands/size.md | 29 +-- docs/commands/skip-until.md | 14 -- docs/commands/skip-while.md | 52 ----- docs/commands/skip.md | 43 ++-- docs/commands/skip_until.md | 23 +++ docs/commands/skip_while.md | 23 +++ docs/commands/sleep.md | 35 +++- docs/commands/sort-by.md | 129 +++--------- docs/commands/source.md | 18 +- docs/commands/split-by.md | 37 +++- docs/commands/split-chars.md | 17 -- docs/commands/split-column.md | 72 ------- docs/commands/split-row.md | 34 ---- docs/commands/split.md | 20 +- docs/commands/split_chars.md | 19 ++ docs/commands/split_column.md | 18 ++ docs/commands/split_row.md | 16 ++ docs/commands/start.md | 28 --- docs/commands/str-camel-case.md | 20 -- docs/commands/str-capitalize.md | 20 -- docs/commands/str-collect.md | 20 -- docs/commands/str-contains.md | 27 --- docs/commands/str-downcase.md | 20 -- docs/commands/str-ends-with.md | 21 -- docs/commands/str-find-replace.md | 28 --- docs/commands/str-index-of.md | 48 ----- docs/commands/str-kebab-case.md | 20 -- docs/commands/str-length.md | 25 --- docs/commands/str-lpad.md | 37 ---- docs/commands/str-ltrim.md | 26 --- docs/commands/str-pascal-case.md | 20 -- docs/commands/str-reverse.md | 20 -- docs/commands/str-rpad.md | 37 ---- docs/commands/str-rtrim.md | 26 --- docs/commands/str-screaming-snake-case.md | 20 -- docs/commands/str-snake-case.md | 20 -- docs/commands/str-starts-with.md | 21 -- docs/commands/str-substring.md | 41 ---- docs/commands/str-to-datetime.md | 43 ---- docs/commands/str-to-decimal.md | 20 -- docs/commands/str-to-int.md | 36 ---- docs/commands/str-trim.md | 26 --- docs/commands/str-upcase.md | 20 -- docs/commands/str.md | 89 +------- docs/commands/str_camel-case.md | 38 ++++ docs/commands/str_capitalize.md | 33 +++ docs/commands/str_collect.md | 28 +++ docs/commands/str_contains.md | 50 +++++ docs/commands/str_downcase.md | 38 ++++ docs/commands/str_ends-with.md | 29 +++ docs/commands/str_find-replace.md | 36 ++++ docs/commands/str_index-of.md | 51 +++++ docs/commands/str_kebab-case.md | 38 ++++ docs/commands/str_length.md | 28 +++ docs/commands/str_lpad.md | 40 ++++ docs/commands/str_pascal-case.md | 38 ++++ docs/commands/str_reverse.md | 23 +++ docs/commands/str_rpad.md | 40 ++++ docs/commands/str_screaming-snake-case.md | 38 ++++ docs/commands/str_snake-case.md | 38 ++++ docs/commands/str_starts-with.md | 34 ++++ docs/commands/str_substring.md | 44 ++++ docs/commands/str_to-decimal.md | 12 ++ docs/commands/str_to-int.md | 12 ++ docs/commands/str_trim.md | 59 ++++++ docs/commands/str_upcase.md | 23 +++ docs/commands/sys.md | 53 +---- docs/commands/table.md | 22 +- docs/commands/tags.md | 45 ----- docs/commands/term_size.md | 34 ++++ docs/commands/textview.md | 11 - docs/commands/textview_config.md | 63 ------ docs/commands/to-bson.md | 11 - docs/commands/to-csv.md | 123 ----------- docs/commands/to-html.md | 17 -- docs/commands/to-json.md | 55 ----- docs/commands/to-md.md | 67 ------ docs/commands/to-sqlite.md | 11 - docs/commands/to-toml.md | 113 ----------- docs/commands/to-tsv.md | 84 -------- docs/commands/to-url.md | 41 ---- docs/commands/to-xml.md | 76 ------- docs/commands/to-yaml.md | 66 ------ docs/commands/to.md | 58 +----- docs/commands/to_csv.md | 29 +++ docs/commands/to_html.md | 38 ++++ docs/commands/to_json.md | 23 +++ docs/commands/to_md.md | 34 ++++ docs/commands/to_toml.md | 19 ++ docs/commands/to_tsv.md | 23 +++ docs/commands/to_url.md | 19 ++ docs/commands/to_xml.md | 28 +++ docs/commands/to_yaml.md | 19 ++ docs/commands/touch.md | 60 +----- docs/commands/transpose.md | 18 ++ docs/commands/tree.md | 11 - docs/commands/tutor.md | 29 +++ docs/commands/unalias.md | 12 ++ docs/commands/uniq.md | 72 ++++--- docs/commands/update.md | 69 ++----- docs/commands/update_cells.md | 47 +++++ docs/commands/url-host.md | 20 -- docs/commands/url-path.md | 25 --- docs/commands/url-query.md | 25 --- docs/commands/url-scheme.md | 25 --- docs/commands/url.md | 21 +- docs/commands/url_host.md | 23 +++ docs/commands/url_path.md | 28 +++ docs/commands/url_query.md | 28 +++ docs/commands/url_scheme.md | 28 +++ docs/commands/use.md | 16 ++ docs/commands/version.md | 17 +- docs/commands/view-source.md | 16 ++ docs/commands/where.md | 106 +--------- docs/commands/which.md | 108 ++-------- docs/commands/with-env.md | 47 +++-- docs/commands/wrap.md | 66 +----- docs/commands/xpath.md | 14 -- docs/commands/zip.md | 23 +++ docs/make_docs.nu | 65 ++++++ 478 files changed, 7676 insertions(+), 8045 deletions(-) delete mode 100644 docs/commands/README.md delete mode 100644 docs/commands/ansi-strip.md create mode 100644 docs/commands/ansi_gradient.md create mode 100644 docs/commands/ansi_strip.md delete mode 100644 docs/commands/autoenv-trust.md delete mode 100644 docs/commands/autoenv-untrust.md delete mode 100644 docs/commands/autoenv.md delete mode 100644 docs/commands/autoview.md delete mode 100644 docs/commands/binaryview.md delete mode 100644 docs/commands/chart-bar.md delete mode 100644 docs/commands/chart-line.md delete mode 100644 docs/commands/chart.md delete mode 100644 docs/commands/clip.md create mode 100644 docs/commands/collect.md create mode 100644 docs/commands/columns.md delete mode 100644 docs/commands/config-clear.md delete mode 100644 docs/commands/config-get.md delete mode 100644 docs/commands/config-path.md delete mode 100644 docs/commands/config-remove.md delete mode 100644 docs/commands/config-set.md delete mode 100644 docs/commands/config-set_into.md delete mode 100644 docs/commands/config.md create mode 100644 docs/commands/dataframe.md delete mode 100644 docs/commands/date-format.md delete mode 100644 docs/commands/date-humanize.md delete mode 100644 docs/commands/date-list-timezone.md delete mode 100644 docs/commands/date-now.md delete mode 100644 docs/commands/date-to-table.md delete mode 100644 docs/commands/date-to-timezone.md create mode 100644 docs/commands/date_format.md create mode 100644 docs/commands/date_humanize.md create mode 100644 docs/commands/date_list-timezone.md create mode 100644 docs/commands/date_now.md create mode 100644 docs/commands/date_to-table.md create mode 100644 docs/commands/date_to-timezone.md create mode 100644 docs/commands/decode.md create mode 100644 docs/commands/def-env.md create mode 100644 docs/commands/detect_columns.md create mode 100644 docs/commands/dfr.md create mode 100644 docs/commands/dfr_aggregate.md create mode 100644 docs/commands/dfr_all-false.md create mode 100644 docs/commands/dfr_all-true.md create mode 100644 docs/commands/dfr_append.md create mode 100644 docs/commands/dfr_arg-max.md create mode 100644 docs/commands/dfr_arg-min.md create mode 100644 docs/commands/dfr_arg-sort.md create mode 100644 docs/commands/dfr_arg-true.md create mode 100644 docs/commands/dfr_arg-unique.md create mode 100644 docs/commands/dfr_column.md create mode 100644 docs/commands/dfr_concatenate.md create mode 100644 docs/commands/dfr_contains.md create mode 100644 docs/commands/dfr_count-null.md create mode 100644 docs/commands/dfr_count-unique.md create mode 100644 docs/commands/dfr_cumulative.md create mode 100644 docs/commands/dfr_describe.md create mode 100644 docs/commands/dfr_drop-nulls.md create mode 100644 docs/commands/dfr_drop.md create mode 100644 docs/commands/dfr_dtypes.md create mode 100644 docs/commands/dfr_filter-with.md create mode 100644 docs/commands/dfr_first.md create mode 100644 docs/commands/dfr_get-day.md create mode 100644 docs/commands/dfr_get-hour.md create mode 100644 docs/commands/dfr_get-minute.md create mode 100644 docs/commands/dfr_get-month.md create mode 100644 docs/commands/dfr_get-nanosecond.md create mode 100644 docs/commands/dfr_get-ordinal.md create mode 100644 docs/commands/dfr_get-second.md create mode 100644 docs/commands/dfr_get-week.md create mode 100644 docs/commands/dfr_get-weekday.md create mode 100644 docs/commands/dfr_get-year.md create mode 100644 docs/commands/dfr_get.md create mode 100644 docs/commands/dfr_group-by.md create mode 100644 docs/commands/dfr_is-duplicated.md create mode 100644 docs/commands/dfr_is-in.md create mode 100644 docs/commands/dfr_is-not-null.md create mode 100644 docs/commands/dfr_is-null.md create mode 100644 docs/commands/dfr_is-unique.md create mode 100644 docs/commands/dfr_join.md create mode 100644 docs/commands/dfr_last.md create mode 100644 docs/commands/dfr_melt.md create mode 100644 docs/commands/dfr_not.md create mode 100644 docs/commands/dfr_open.md create mode 100644 docs/commands/dfr_pivot.md create mode 100644 docs/commands/dfr_rename-col.md create mode 100644 docs/commands/dfr_rename.md create mode 100644 docs/commands/dfr_replace-all.md create mode 100644 docs/commands/dfr_replace.md create mode 100644 docs/commands/dfr_rolling.md create mode 100644 docs/commands/dfr_sample.md create mode 100644 docs/commands/dfr_set-with-idx.md create mode 100644 docs/commands/dfr_set.md create mode 100644 docs/commands/dfr_shape.md create mode 100644 docs/commands/dfr_shift.md create mode 100644 docs/commands/dfr_slice.md create mode 100644 docs/commands/dfr_sort.md create mode 100644 docs/commands/dfr_str-lengths.md create mode 100644 docs/commands/dfr_str-slice.md create mode 100644 docs/commands/dfr_strftime.md create mode 100644 docs/commands/dfr_take.md create mode 100644 docs/commands/dfr_to-csv.md create mode 100644 docs/commands/dfr_to-df.md create mode 100644 docs/commands/dfr_to-dummies.md create mode 100644 docs/commands/dfr_to-lowercase.md create mode 100644 docs/commands/dfr_to-nu.md create mode 100644 docs/commands/dfr_to-parquet.md create mode 100644 docs/commands/dfr_to-uppercase.md create mode 100644 docs/commands/dfr_unique.md create mode 100644 docs/commands/dfr_value-counts.md create mode 100644 docs/commands/dfr_with-column.md delete mode 100644 docs/commands/drop-column.md create mode 100644 docs/commands/drop_column.md create mode 100644 docs/commands/drop_nth.md delete mode 100644 docs/commands/each-group.md delete mode 100644 docs/commands/each-window.md create mode 100644 docs/commands/each_group.md create mode 100644 docs/commands/each_window.md create mode 100644 docs/commands/env.md create mode 100644 docs/commands/error_make.md create mode 100644 docs/commands/export.md create mode 100644 docs/commands/export_def-env.md create mode 100644 docs/commands/export_def.md create mode 100644 docs/commands/export_env.md create mode 100644 docs/commands/extern.md create mode 100644 docs/commands/find.md create mode 100644 docs/commands/fmt.md delete mode 100644 docs/commands/format-filesize.md delete mode 100644 docs/commands/from-bson.md delete mode 100644 docs/commands/from-csv.md delete mode 100644 docs/commands/from-eml.md delete mode 100644 docs/commands/from-ics.md delete mode 100644 docs/commands/from-ini.md delete mode 100644 docs/commands/from-json.md delete mode 100644 docs/commands/from-ods.md delete mode 100644 docs/commands/from-sqlite.md delete mode 100644 docs/commands/from-ssv.md delete mode 100644 docs/commands/from-toml.md delete mode 100644 docs/commands/from-tsv.md delete mode 100644 docs/commands/from-url.md delete mode 100644 docs/commands/from-vcf.md delete mode 100644 docs/commands/from-xlsx.md delete mode 100644 docs/commands/from-xml.md delete mode 100644 docs/commands/from-yaml.md delete mode 100644 docs/commands/from-yml.md create mode 100644 docs/commands/from_csv.md create mode 100644 docs/commands/from_eml.md create mode 100644 docs/commands/from_ics.md create mode 100644 docs/commands/from_ini.md create mode 100644 docs/commands/from_json.md create mode 100644 docs/commands/from_ods.md create mode 100644 docs/commands/from_ssv.md create mode 100644 docs/commands/from_toml.md create mode 100644 docs/commands/from_tsv.md create mode 100644 docs/commands/from_url.md create mode 100644 docs/commands/from_vcf.md create mode 100644 docs/commands/from_xlsx.md create mode 100644 docs/commands/from_xml.md create mode 100644 docs/commands/from_yaml.md create mode 100644 docs/commands/from_yml.md create mode 100644 docs/commands/g.md create mode 100644 docs/commands/git_checkout.md create mode 100644 docs/commands/git_push.md create mode 100644 docs/commands/grid.md delete mode 100644 docs/commands/group-by-date.md create mode 100644 docs/commands/gstat.md delete mode 100644 docs/commands/hash-base64.md delete mode 100644 docs/commands/hash-md5.md create mode 100644 docs/commands/hash_base64.md create mode 100644 docs/commands/hash_md5.md create mode 100644 docs/commands/hash_sha256.md create mode 100644 docs/commands/hide.md delete mode 100644 docs/commands/histogram.md create mode 100644 docs/commands/ignore.md create mode 100644 docs/commands/input.md delete mode 100644 docs/commands/into-binary.md delete mode 100644 docs/commands/into-int.md delete mode 100644 docs/commands/into-string.md create mode 100644 docs/commands/into_binary.md create mode 100644 docs/commands/into_bool.md create mode 100644 docs/commands/into_datetime.md create mode 100644 docs/commands/into_decimal.md create mode 100644 docs/commands/into_filesize.md create mode 100644 docs/commands/into_int.md create mode 100644 docs/commands/into_string.md delete mode 100644 docs/commands/keep-until.md delete mode 100644 docs/commands/keep-while.md create mode 100644 docs/commands/keep_until.md create mode 100644 docs/commands/keep_while.md create mode 100644 docs/commands/keybindings.md create mode 100644 docs/commands/keybindings_default.md create mode 100644 docs/commands/keybindings_list.md create mode 100644 docs/commands/keybindings_listen.md delete mode 100644 docs/commands/match.md delete mode 100644 docs/commands/math-abs.md delete mode 100644 docs/commands/math-avg.md delete mode 100644 docs/commands/math-ceil.md delete mode 100644 docs/commands/math-eval.md delete mode 100644 docs/commands/math-floor.md delete mode 100644 docs/commands/math-max.md delete mode 100644 docs/commands/math-median.md delete mode 100644 docs/commands/math-min.md delete mode 100644 docs/commands/math-mode.md delete mode 100644 docs/commands/math-product.md delete mode 100644 docs/commands/math-round.md delete mode 100644 docs/commands/math-sqrt.md delete mode 100644 docs/commands/math-stddev.md delete mode 100644 docs/commands/math-sum.md delete mode 100644 docs/commands/math-variance.md create mode 100644 docs/commands/math_abs.md create mode 100644 docs/commands/math_avg.md create mode 100644 docs/commands/math_ceil.md create mode 100644 docs/commands/math_eval.md create mode 100644 docs/commands/math_floor.md create mode 100644 docs/commands/math_max.md create mode 100644 docs/commands/math_median.md create mode 100644 docs/commands/math_min.md create mode 100644 docs/commands/math_mode.md create mode 100644 docs/commands/math_product.md create mode 100644 docs/commands/math_round.md create mode 100644 docs/commands/math_sqrt.md create mode 100644 docs/commands/math_stddev.md create mode 100644 docs/commands/math_sum.md create mode 100644 docs/commands/math_variance.md create mode 100644 docs/commands/metadata.md create mode 100644 docs/commands/module.md create mode 100644 docs/commands/nu-highlight.md create mode 100644 docs/commands/par-each.md create mode 100644 docs/commands/par-each_group.md delete mode 100644 docs/commands/path-basename.md delete mode 100644 docs/commands/path-dirname.md delete mode 100644 docs/commands/path-exists.md delete mode 100644 docs/commands/path-expand.md delete mode 100644 docs/commands/path-join.md delete mode 100644 docs/commands/path-parse.md delete mode 100644 docs/commands/path-relative-to.md delete mode 100644 docs/commands/path-split.md delete mode 100644 docs/commands/path-type.md create mode 100644 docs/commands/path_basename.md create mode 100644 docs/commands/path_dirname.md create mode 100644 docs/commands/path_exists.md create mode 100644 docs/commands/path_expand.md create mode 100644 docs/commands/path_join.md create mode 100644 docs/commands/path_parse.md create mode 100644 docs/commands/path_relative-to.md create mode 100644 docs/commands/path_split.md create mode 100644 docs/commands/path_type.md delete mode 100644 docs/commands/post.md delete mode 100644 docs/commands/pwd.md create mode 100644 docs/commands/query.md create mode 100644 docs/commands/query_json.md create mode 100644 docs/commands/query_web.md create mode 100644 docs/commands/query_xml.md delete mode 100644 docs/commands/random-bool.md delete mode 100644 docs/commands/random-chars.md delete mode 100644 docs/commands/random-decimal.md delete mode 100644 docs/commands/random-dice.md delete mode 100644 docs/commands/random-integer.md delete mode 100644 docs/commands/random-uuid.md create mode 100644 docs/commands/random_bool.md create mode 100644 docs/commands/random_chars.md create mode 100644 docs/commands/random_decimal.md create mode 100644 docs/commands/random_dice.md create mode 100644 docs/commands/random_integer.md create mode 100644 docs/commands/random_uuid.md create mode 100644 docs/commands/register.md delete mode 100644 docs/commands/roll-column.md delete mode 100644 docs/commands/roll-up.md create mode 100644 docs/commands/roll_down.md create mode 100644 docs/commands/roll_left.md create mode 100644 docs/commands/roll_right.md create mode 100644 docs/commands/roll_up.md delete mode 100644 docs/commands/rotate-counter-clockwise.md create mode 100644 docs/commands/run_external.md delete mode 100644 docs/commands/s3.md delete mode 100644 docs/commands/selector.md delete mode 100644 docs/commands/seq-date.md create mode 100644 docs/commands/seq_date.md delete mode 100644 docs/commands/skip-until.md delete mode 100644 docs/commands/skip-while.md create mode 100644 docs/commands/skip_until.md create mode 100644 docs/commands/skip_while.md delete mode 100644 docs/commands/split-chars.md delete mode 100644 docs/commands/split-column.md delete mode 100644 docs/commands/split-row.md create mode 100644 docs/commands/split_chars.md create mode 100644 docs/commands/split_column.md create mode 100644 docs/commands/split_row.md delete mode 100644 docs/commands/start.md delete mode 100644 docs/commands/str-camel-case.md delete mode 100644 docs/commands/str-capitalize.md delete mode 100644 docs/commands/str-collect.md delete mode 100644 docs/commands/str-contains.md delete mode 100644 docs/commands/str-downcase.md delete mode 100644 docs/commands/str-ends-with.md delete mode 100644 docs/commands/str-find-replace.md delete mode 100644 docs/commands/str-index-of.md delete mode 100644 docs/commands/str-kebab-case.md delete mode 100644 docs/commands/str-length.md delete mode 100644 docs/commands/str-lpad.md delete mode 100644 docs/commands/str-ltrim.md delete mode 100644 docs/commands/str-pascal-case.md delete mode 100644 docs/commands/str-reverse.md delete mode 100644 docs/commands/str-rpad.md delete mode 100644 docs/commands/str-rtrim.md delete mode 100644 docs/commands/str-screaming-snake-case.md delete mode 100644 docs/commands/str-snake-case.md delete mode 100644 docs/commands/str-starts-with.md delete mode 100644 docs/commands/str-substring.md delete mode 100644 docs/commands/str-to-datetime.md delete mode 100644 docs/commands/str-to-decimal.md delete mode 100644 docs/commands/str-to-int.md delete mode 100644 docs/commands/str-trim.md delete mode 100644 docs/commands/str-upcase.md create mode 100644 docs/commands/str_camel-case.md create mode 100644 docs/commands/str_capitalize.md create mode 100644 docs/commands/str_collect.md create mode 100644 docs/commands/str_contains.md create mode 100644 docs/commands/str_downcase.md create mode 100644 docs/commands/str_ends-with.md create mode 100644 docs/commands/str_find-replace.md create mode 100644 docs/commands/str_index-of.md create mode 100644 docs/commands/str_kebab-case.md create mode 100644 docs/commands/str_length.md create mode 100644 docs/commands/str_lpad.md create mode 100644 docs/commands/str_pascal-case.md create mode 100644 docs/commands/str_reverse.md create mode 100644 docs/commands/str_rpad.md create mode 100644 docs/commands/str_screaming-snake-case.md create mode 100644 docs/commands/str_snake-case.md create mode 100644 docs/commands/str_starts-with.md create mode 100644 docs/commands/str_substring.md create mode 100644 docs/commands/str_to-decimal.md create mode 100644 docs/commands/str_to-int.md create mode 100644 docs/commands/str_trim.md create mode 100644 docs/commands/str_upcase.md delete mode 100644 docs/commands/tags.md create mode 100644 docs/commands/term_size.md delete mode 100644 docs/commands/textview.md delete mode 100644 docs/commands/textview_config.md delete mode 100644 docs/commands/to-bson.md delete mode 100644 docs/commands/to-csv.md delete mode 100644 docs/commands/to-html.md delete mode 100644 docs/commands/to-json.md delete mode 100644 docs/commands/to-md.md delete mode 100644 docs/commands/to-sqlite.md delete mode 100644 docs/commands/to-toml.md delete mode 100644 docs/commands/to-tsv.md delete mode 100644 docs/commands/to-url.md delete mode 100644 docs/commands/to-xml.md delete mode 100644 docs/commands/to-yaml.md create mode 100644 docs/commands/to_csv.md create mode 100644 docs/commands/to_html.md create mode 100644 docs/commands/to_json.md create mode 100644 docs/commands/to_md.md create mode 100644 docs/commands/to_toml.md create mode 100644 docs/commands/to_tsv.md create mode 100644 docs/commands/to_url.md create mode 100644 docs/commands/to_xml.md create mode 100644 docs/commands/to_yaml.md create mode 100644 docs/commands/transpose.md delete mode 100644 docs/commands/tree.md create mode 100644 docs/commands/tutor.md create mode 100644 docs/commands/unalias.md create mode 100644 docs/commands/update_cells.md delete mode 100644 docs/commands/url-host.md delete mode 100644 docs/commands/url-path.md delete mode 100644 docs/commands/url-query.md delete mode 100644 docs/commands/url-scheme.md create mode 100644 docs/commands/url_host.md create mode 100644 docs/commands/url_path.md create mode 100644 docs/commands/url_query.md create mode 100644 docs/commands/url_scheme.md create mode 100644 docs/commands/use.md create mode 100644 docs/commands/view-source.md delete mode 100644 docs/commands/xpath.md create mode 100644 docs/commands/zip.md create mode 100644 docs/make_docs.nu diff --git a/crates/nu-engine/src/eval.rs b/crates/nu-engine/src/eval.rs index 535435dc8c..ff53d1f90f 100644 --- a/crates/nu-engine/src/eval.rs +++ b/crates/nu-engine/src/eval.rs @@ -894,6 +894,29 @@ pub fn eval_variable( span, }); + cols.push("examples".to_string()); + vals.push(Value::List { + vals: decl + .examples() + .into_iter() + .map(|x| Value::Record { + cols: vec!["description".into(), "example".into()], + vals: vec![ + Value::String { + val: x.description.to_string(), + span, + }, + Value::String { + val: x.example.to_string(), + span, + }, + ], + span, + }) + .collect(), + span, + }); + cols.push("is_binary".to_string()); vals.push(Value::Bool { val: decl.is_binary(), diff --git a/docs/commands/README.md b/docs/commands/README.md deleted file mode 100644 index 6b3807dff4..0000000000 --- a/docs/commands/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# How do I get started? - -Pick any command from the checklist and write a comment acknowledging you started work. - -## Instructions for documenting a Nu command of your choosing - -Name the file after the command, like so: - -`command.md` - -Example: If you want to add documentation for the Nu command `enter`, create a file named `enter.md`, write documentation, save it at `/docs/commands/[your_command_picked].md` as and create your pull request. - -## What kind of documentation should I write? - -Anything you want that you believe it *best* documents the command and the way you would like to see it. Here are some of our ideas of documentation we would *love* to see (feel free to add yours): - -* Examples of using the command (max creativity welcomed!) -* Description of the command. -* Command usage. - -## Anything else? - -Of course! (These are drafts) so feel free to leave feedback and suggestions in the same file. - -Happy Documenting. diff --git a/docs/commands/alias.md b/docs/commands/alias.md index f29fa88e75..ae94100ce7 100644 --- a/docs/commands/alias.md +++ b/docs/commands/alias.md @@ -1,32 +1,17 @@ -# alias +--- +title: alias +layout: command +version: 0.59.0 +--- -This command allows you to define shortcuts for other common commands. By default, they only apply to the current session. To persist them, add them to your config. +Alias a command (with optional flags) to a new name -Syntax: `alias = ` +## Signature -The command expects two parameters: +```> alias (name) (initial_value)``` -* The name of the alias -* The body of the alias +## Parameters -## Examples + - `name`: name of the alias + - `initial_value`: equals sign followed by value -Define a custom `myecho` command as an alias: - -```shell -> alias myecho = echo -> myecho "hello world" -hello world -``` - -The suggested help command works! - -```shell -> myecho -h - -Usage: - > myecho {flags} - -flags: - -h, --help: Display this help message -``` diff --git a/docs/commands/all.md b/docs/commands/all.md index 260d780468..272ebac66b 100644 --- a/docs/commands/all.md +++ b/docs/commands/all.md @@ -1,25 +1,28 @@ -# all? -Find if the table rows matches the condition. +--- +title: all? +layout: command +version: 0.59.0 +--- -## Usage -```shell -> all? {flags} - ``` +Test if every element of the input matches a predicate. + +## Signature + +```> all? (predicate)``` ## Parameters -* `` the condition that must match -## Flags -* -h, --help: Display this help message + - `predicate`: the predicate that must match ## Examples - Find if services are running + +Find if services are running ```shell > echo [[status]; [UP] [UP]] | all? status == UP - ``` +``` - Check that all values are even +Check that all values are even ```shell > echo [2 4 6 8] | all? ($it mod 2) == 0 - ``` +``` diff --git a/docs/commands/ansi-strip.md b/docs/commands/ansi-strip.md deleted file mode 100644 index ec1d082c81..0000000000 --- a/docs/commands/ansi-strip.md +++ /dev/null @@ -1,20 +0,0 @@ -# ansi strip -strip ansi escape sequences from string - -## Usage -```shell -> ansi strip ...args {flags} - ``` - -## Parameters -* ...args: optionally, remove ansi sequences by column paths - -## Flags -* -h, --help: Display this help message - -## Examples - strip ansi escape sequences from string -```shell -> echo [(ansi gb) 'hello' (ansi reset)] | str collect | ansi strip - ``` - diff --git a/docs/commands/ansi.md b/docs/commands/ansi.md index 4256846be7..b9c1952784 100644 --- a/docs/commands/ansi.md +++ b/docs/commands/ansi.md @@ -1,88 +1,46 @@ -# ansi +--- +title: ansi +layout: command +version: 0.59.0 +--- + Output ANSI codes to change color. -For escape sequences: -Escape: `\x1b[` is not required for --escape parameter +## Signature -Format: `#(;#)m` - -Example: 1;31m for bold red or 2;37;41m for dimmed white fg with red bg -There can be multiple text formatting sequence numbers -separated by a ; and ending with an m where the # is of the -following values: - -attributes -* 0 reset / normal display -* 1 bold or increased intensity -* 2 faint or decreased intensity -* 3 italic on (non-mono font) -* 4 underline on -* 5 slow blink on -* 6 fast blink on -* 7 reverse video on -* 8 nondisplayed (invisible) on -* 9 strike-through on - -``` - foreground/bright colors background/bright colors - 30/90 black 40/100 black - 31/91 red 41/101 red - 32/92 green 42/102 green - 33/93 yellow 43/103 yellow - 34/94 blue 44/104 blue - 35/95 magenta 45/105 magenta - 36/96 cyan 46/106 cyan - 37/97 white 47/107 white - https://en.wikipedia.org/wiki/ANSI_escape_code -``` -OSC: `\x1b]` is not required for --osc parameter - -Example: `echo [(ansi -o '0') 'some title' (char bel)] | str collect` - -Format: -* 0 Set window title and icon name -* 1 Set icon name -* 2 Set window title -* 4 Set/read color palette -* 9 iTerm2 Grown notifications -* 10 Set foreground color (x11 color spec) -* 11 Set background color (x11 color spec) -* ... others - -## Usage -```shell -> ansi (code) {flags} - ``` - -## Subcommands -* ansi strip - strip ansi escape sequences from string +```> ansi (code) --escape --osc --list``` ## Parameters -* `(code)` the name of the code to use like 'green' or 'reset' to reset the color -## Flags -* -h, --help: Display this help message -* -e, --escape : escape sequence without the escape character(s) -* -o, --osc : operating system command (ocs) escape sequence without the escape character(s) + - `code`: the name of the code to use like 'green' or 'reset' to reset the color + - `--escape`: escape sequence without the escape character(s) + - `--osc`: operating system command (ocs) escape sequence without the escape character(s) + - `--list`: list available ansi code names ## Examples - Change color to green + +Change color to green ```shell > ansi green - ``` +``` - Reset the color +Reset the color ```shell > ansi reset - ``` +``` - Use ansi to color text (rb = red bold, gb = green bold, pb = purple bold) +Use ansi to color text (rb = red bold, gb = green bold, pb = purple bold) ```shell -> echo [(ansi rb) Hello " " (ansi gb) Nu " " (ansi pb) World] | str collect - ``` +> echo [(ansi rb) Hello " " (ansi gb) Nu " " (ansi pb) World (ansi reset)] | str collect +``` - Use ansi to color text (rb = red bold, gb = green bold, pb = purple bold) +Use ansi to color text (italic bright yellow on red 'Hello' with green bold 'Nu' and purble bold 'World') ```shell -> echo [(ansi -e '3;93;41m') Hello (ansi reset) " " (ansi gb) Nu " " (ansi pb) World] | str collect - ``` +> echo [(ansi -e '3;93;41m') Hello (ansi reset) " " (ansi gb) Nu " " (ansi pb) World (ansi reset)] | str collect +``` + +Use ansi to color text with a style (blue on red in bold) +```shell +> $"(ansi -e { fg: '#0000ff' bg: '#ff0000' attr: b })Hello Nu World(ansi reset)" +``` diff --git a/docs/commands/ansi_gradient.md b/docs/commands/ansi_gradient.md new file mode 100644 index 0000000000..44278c33f9 --- /dev/null +++ b/docs/commands/ansi_gradient.md @@ -0,0 +1,42 @@ +--- +title: ansi gradient +layout: command +version: 0.59.0 +--- + +draw text with a provided start and end code making a gradient + +## Signature + +```> ansi gradient ...column path --fgstart --fgend --bgstart --bgend``` + +## Parameters + + - `...column path`: optionally, draw gradients using text from column paths + - `--fgstart {string}`: foreground gradient start color in hex (0x123456) + - `--fgend {string}`: foreground gradient end color in hex + - `--bgstart {string}`: background gradient start color in hex + - `--bgend {string}`: background gradient end color in hex + +## Examples + +draw text in a gradient with foreground start and end colors +```shell +> echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart 0x40c9ff --fgend 0xe81cff +``` + +draw text in a gradient with foreground start and end colors and background start and end colors +```shell +> echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart 0x40c9ff --fgend 0xe81cff --bgstart 0xe81cff --bgend 0x40c9ff +``` + +draw text in a gradient by specifying foreground start color - end color is assumed to be black +```shell +> echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart 0x40c9ff +``` + +draw text in a gradient by specifying foreground end color - start color is assumed to be black +```shell +> echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgend 0xe81cff +``` + diff --git a/docs/commands/ansi_strip.md b/docs/commands/ansi_strip.md new file mode 100644 index 0000000000..beebcebac3 --- /dev/null +++ b/docs/commands/ansi_strip.md @@ -0,0 +1,23 @@ +--- +title: ansi strip +layout: command +version: 0.59.0 +--- + +strip ansi escape sequences from string + +## Signature + +```> ansi strip ...column path``` + +## Parameters + + - `...column path`: optionally, remove ansi sequences by column paths + +## Examples + +strip ansi escape sequences from string +```shell +> echo [ (ansi green) (ansi cursor_on) "hello" ] | str collect | ansi strip +``` + diff --git a/docs/commands/any.md b/docs/commands/any.md index fbb41e1141..5c78858338 100644 --- a/docs/commands/any.md +++ b/docs/commands/any.md @@ -1,25 +1,28 @@ -# any? -Find if the table rows matches the condition. +--- +title: any? +layout: command +version: 0.59.0 +--- -## Usage -```shell -> any? {flags} - ``` +Tests if any element of the input matches a predicate. + +## Signature + +```> any? (predicate)``` ## Parameters -* `` the condition that must match -## Flags -* -h, --help: Display this help message + - `predicate`: the predicate that must match ## Examples - Find if a service is not running + +Find if a service is not running ```shell > echo [[status]; [UP] [DOWN] [UP]] | any? status == DOWN - ``` +``` - Check if any of the values is odd +Check if any of the values is odd ```shell > echo [2 4 1 6 8] | any? ($it mod 2) == 1 - ``` +``` diff --git a/docs/commands/append.md b/docs/commands/append.md index c9e6287491..5e2fd23690 100644 --- a/docs/commands/append.md +++ b/docs/commands/append.md @@ -1,105 +1,33 @@ -# append +--- +title: append +layout: command +version: 0.59.0 +--- Append a row to the table. +## Signature + +```> append (row)``` + +## Parameters + + - `row`: the row to append + ## Examples -Given the following text file `cities.txt` containing cities: - +Append one Int item ```shell -Canberra -London -Nairobi -Washington +> [0,1,2,3] | append 4 ``` -And getting back a Nu table: - +Append three Int items ```shell -> open cities.txt | lines -───┬──────────── - 0 │ Canberra - 1 │ London - 2 │ Nairobi - 3 │ Washington -───┴──────────── +> [0,1] | append [2,3,4] ``` -Add the city named `Beijing` like so: - +Append Ints and Strings ```shell -> open cities.txt | lines | append Beijing -───┬──────────── - 0 │ Canberra - 1 │ London - 2 │ Nairobi - 3 │ Washington - 4 │ Beijing -───┴──────────── +> [0,1] | append [2,nu,4,shell] ``` -It's not possible to add multiple rows at once, so you'll need to use `append` multiple times: - -```shell -> open cities.txt | lines | append Beijing | append "Buenos Aires" -───┬────────────── - 0 │ Canberra - 1 │ London - 2 │ Nairobi - 3 │ Washington - 4 │ Beijing - 5 │ Buenos Aires -───┴────────────── -``` - -So far we have been working with a table without a column, which leaves us with plain rows. Let's `wrap` the plain rows into a column called `city` and save it as a json file called `cities.json`: - -Before we save, let's check how it looks after wrapping: - -```shell -open cities.txt | lines | wrap city -───┬──────────── - # │ city -───┼──────────── - 0 │ Canberra - 1 │ London - 2 │ Nairobi - 3 │ Washington -───┴──────────── -``` - -And save: - -`> open cities.txt | lines | wrap city | save cities.json` - -Since we will be working with rows that have a column, appending like before won't quite give us back what we want: - -```shell -> open cities.json | append Guayaquil -───┬──────────── - # │ city -───┼──────────── - 0 │ Canberra - 1 │ London - 2 │ Nairobi - 3 │ Washington -───┴──────────── -───┬─────────── - 4 │ Guayaquil -───┴─────────── -``` - -We append a row literal directly: - -```shell -> open cities.json | append [[city]; [Guayaquil]] -───┬──────────── - # │ city -───┼──────────── - 0 │ Canberra - 1 │ London - 2 │ Nairobi - 3 │ Washington - 4 │ Guayaquil -───┴──────────── -``` \ No newline at end of file diff --git a/docs/commands/autoenv-trust.md b/docs/commands/autoenv-trust.md deleted file mode 100644 index a6500abfbc..0000000000 --- a/docs/commands/autoenv-trust.md +++ /dev/null @@ -1,25 +0,0 @@ -# autoenv trust -Trust a .nu-env file in the current or given directory - -## Usage -```shell -> autoenv trust (dir) {flags} - ``` - -## Parameters -* `(dir)` Directory to allow - -## Flags -* -h, --help: Display this help message - -## Examples - Allow .nu-env file in current directory -```shell -> autoenv trust - ``` - - Allow .nu-env file in directory foo -```shell -> autoenv trust foo - ``` - diff --git a/docs/commands/autoenv-untrust.md b/docs/commands/autoenv-untrust.md deleted file mode 100644 index 29085b6341..0000000000 --- a/docs/commands/autoenv-untrust.md +++ /dev/null @@ -1,25 +0,0 @@ -# autoenv untrust -Untrust a .nu-env file in the current or given directory - -## Usage -```shell -> autoenv untrust (dir) {flags} - ``` - -## Parameters -* `(dir)` Directory to disallow - -## Flags -* -h, --help: Display this help message - -## Examples - Disallow .nu-env file in current directory -```shell -> autoenv untrust - ``` - - Disallow .nu-env file in directory foo -```shell -> autoenv untrust foo - ``` - diff --git a/docs/commands/autoenv.md b/docs/commands/autoenv.md deleted file mode 100644 index b71b758077..0000000000 --- a/docs/commands/autoenv.md +++ /dev/null @@ -1,34 +0,0 @@ -# autoenv -Manage directory specific environment variables and scripts. - -Create a file called .nu-env in any directory and run 'autoenv trust' to let nushell load it when entering the directory. -The .nu-env file has the same format as your $HOME/nu/config.toml file. By loading a .nu-env file the following applies: - * - environment variables (section \"[env]\") are loaded from the .nu-env file. Those env variables only exist in this directory (and children directories) - * - the \"startup\" commands are run when entering the directory - * - the \"on_exit\" commands are run when leaving the directory - - -## Usage -```shell -> autoenv {flags} - ``` - -## Subcommands -* autoenv trust - Trust a .nu-env file in the current or given directory -* autoenv untrust - Untrust a .nu-env file in the current or given directory - -## Flags -* -h, --help: Display this help message - -## Examples - Example .nu-env file -```shell -> cat .nu-env - ``` - startup = ["echo ...entering the directory", "echo 1 2 3"] - on_exit = ["echo ...leaving the directory"] - - [env] - mykey = "myvalue" - - diff --git a/docs/commands/autoview.md b/docs/commands/autoview.md deleted file mode 100644 index ba6c78ffc9..0000000000 --- a/docs/commands/autoview.md +++ /dev/null @@ -1,59 +0,0 @@ -# autoview - -Print the content of the pipeline as a table or list. -It is the implied or default viewer when none is provided. - -When reading a single value, a table or a list, `autoview` will attempt to view it. -When reading a string that originally comes from a source file it will attempt -to use `textview`. -When reading a binary file it will attempt to display its content as hexadecimal -numbers and the corresponding characters. - -`-h`, `--help` - Display help message. - -## Examples - -In all following examples `autoview` can be removed with no change in the output. -The use of `autoview` at the end of the pipeline is implied when no viewer is -explicitly used. - -```shell -> which nu | get path | autoview -/home/me/.cargo/bin/nu -``` - -```shell -> ls | autoview -────┬────────────────────┬──────┬─────────┬────────────── - # │ name │ type │ size │ modified -────┼────────────────────┼──────┼─────────┼────────────── - 0 │ README.md │ File │ 932 B │ 19 hours ago - 1 │ alias.md │ File │ 2.0 KB │ 19 hours ago - 2 │ append.md │ File │ 1.4 KB │ 19 hours ago - ... - 82 │ wrap.md │ File │ 1.8 KB │ 19 hours ago -────┴────────────────────┴──────┴─────────┴────────────── -``` - -```shell -> echo "# Hi" "## Section" "Some text" | save file.md -> open file.md | autoview -# Hi -## Section -Some text -``` - -`autoview` will use `textview` to colorize the text based on the file format. -The style used by `textview` can be configured in `config.toml`. - -```shell -> open --raw (which nu | get path) | autoview -... -126d1c0: 64 31 66 37 62 30 31 63 36 2e 31 31 38 2e 6c 6c d1f7b01c6.118.ll -126d1d0: 76 6d 2e 34 34 38 37 35 37 31 32 34 39 35 33 39 vm.4487571249539 -126d1e0: 34 34 30 34 30 39 00 61 6e 6f 6e 2e 30 30 61 63 440409.anon.00ac -126d1f0: 37 32 65 36 37 66 32 31 39 34 62 32 32 61 61 63 72e67f2194b22aac -126d200: 62 35 39 37 33 36 30 62 64 31 39 38 2e 31 36 2e b597360bd198.16. -... -``` diff --git a/docs/commands/benchmark.md b/docs/commands/benchmark.md index 1cca60fac2..16e9db6098 100644 --- a/docs/commands/benchmark.md +++ b/docs/commands/benchmark.md @@ -1,26 +1,16 @@ -# benchmark -Runs a block and returns the time it took to execute it. +--- +title: benchmark +layout: command +version: 0.59.0 +--- -## Usage -```shell -> benchmark {flags} - ``` +Time the running time of a block + +## Signature + +```> benchmark (block)``` ## Parameters -* `` the block to run and benchmark -## Flags -* -h, --help: Display this help message -* -p, --passthrough : Display the benchmark results and pass through the block's output - -## Examples - Benchmarks a command within a block -```shell -> benchmark { sleep 500ms } - ``` - - Benchmarks a command within a block and passes its output through -```shell -> echo 45 | benchmark { sleep 500ms } --passthrough {} - ``` + - `block`: the block to run diff --git a/docs/commands/binaryview.md b/docs/commands/binaryview.md deleted file mode 100644 index e3f539bae5..0000000000 --- a/docs/commands/binaryview.md +++ /dev/null @@ -1,14 +0,0 @@ -# binaryview -Autoview of binary data. - -## Usage -```shell -> binaryview {flags} - ``` - -## Flags -* -h, --help: Display this help message -* -l, --lores: use low resolution output mode -* -s, --skip : skip x number of bytes -* -b, --bytes : show y number of bytes - diff --git a/docs/commands/build-string.md b/docs/commands/build-string.md index 95d5ae5c67..9cade6eca3 100644 --- a/docs/commands/build-string.md +++ b/docs/commands/build-string.md @@ -1,20 +1,28 @@ -# build-string -Builds a string from the arguments. +--- +title: build-string +layout: command +version: 0.59.0 +--- -## Usage -```shell -> build-string ...args {flags} - ``` +Create a string from the arguments. + +## Signature + +```> build-string ...rest``` ## Parameters -* ...args: all values to form into the string -## Flags -* -h, --help: Display this help message + - `...rest`: list of string ## Examples - Builds a string from a string and a number, without spaces between them -```shell -> build-string 'foo' 3 - ``` + +Builds a string from letters a b c +```shell +> build-string a b c +``` + +Builds a string from letters a b c +```shell +> build-string (1 + 2) = one ' ' plus ' ' two +``` diff --git a/docs/commands/cal.md b/docs/commands/cal.md index 5ea359de93..43761715cf 100644 --- a/docs/commands/cal.md +++ b/docs/commands/cal.md @@ -1,204 +1,38 @@ -# cal +--- +title: cal +layout: command +version: 0.59.0 +--- -Use `cal` to display a calendar. +Display a calendar. -## Flags +## Signature -* `-y`, `--year`: Display the year column -* `-q`, `--quarter`: Display the quarter column -* `-m`, `--month`: Display the month column -* `--full-year` \: Display a year-long calendar for the specified year -* `--week-start` \: Display the calendar with the specified day as the first day of the week -* `--month-names`: Display the month names instead of integers +```> cal --year --quarter --month --full-year --week-start --month-names``` + +## Parameters + + - `--year`: Display the year column + - `--quarter`: Display the quarter column + - `--month`: Display the month column + - `--full-year {int}`: Display a year-long calendar for the specified year + - `--week-start {string}`: Display the calendar with the specified day as the first day of the week + - `--month-names`: Display the month names instead of integers ## Examples +This month's calendar ```shell > cal -───┬────────┬────────┬─────────┬───────────┬──────────┬────────┬────────── - # │ sunday │ monday │ tuesday │ wednesday │ thursday │ friday │ saturday -───┼────────┼────────┼─────────┼───────────┼──────────┼────────┼────────── - 0 │ │ │ │ │ │ 1 │ 2 - 1 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 - 2 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 │ 16 - 3 │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 │ 23 - 4 │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 │ 30 - 5 │ 31 │ │ │ │ │ │ -───┴────────┴────────┴─────────┴───────────┴──────────┴────────┴────────── ``` +The calendar for all of 2012 ```shell -> cal -yqm --full-year 2020 -────┬──────┬─────────┬───────┬────────┬────────┬─────────┬───────────┬──────────┬────────┬────────── - # │ year │ quarter │ month │ sunday │ monday │ tuesday │ wednesday │ thursday │ friday │ saturday -────┼──────┼─────────┼───────┼────────┼────────┼─────────┼───────────┼──────────┼────────┼────────── - 0 │ 2020 │ 1 │ 1 │ │ │ │ 1 │ 2 │ 3 │ 4 - 1 │ 2020 │ 1 │ 1 │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 - 2 │ 2020 │ 1 │ 1 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 - 3 │ 2020 │ 1 │ 1 │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 - 4 │ 2020 │ 1 │ 1 │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 │ - 5 │ 2020 │ 1 │ 2 │ │ │ │ │ │ │ 1 - 6 │ 2020 │ 1 │ 2 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 - 7 │ 2020 │ 1 │ 2 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 - 8 │ 2020 │ 1 │ 2 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 - 9 │ 2020 │ 1 │ 2 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 - 10 │ 2020 │ 1 │ 3 │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 - 11 │ 2020 │ 1 │ 3 │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 - 12 │ 2020 │ 1 │ 3 │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 - 13 │ 2020 │ 1 │ 3 │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 - 14 │ 2020 │ 1 │ 3 │ 29 │ 30 │ 31 │ │ │ │ - 15 │ 2020 │ 2 │ 4 │ │ │ │ 1 │ 2 │ 3 │ 4 - 16 │ 2020 │ 2 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 - 17 │ 2020 │ 2 │ 4 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 - 18 │ 2020 │ 2 │ 4 │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 - 19 │ 2020 │ 2 │ 4 │ 26 │ 27 │ 28 │ 29 │ 30 │ │ - 20 │ 2020 │ 2 │ 5 │ │ │ │ │ │ 1 │ 2 - 21 │ 2020 │ 2 │ 5 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 - 22 │ 2020 │ 2 │ 5 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 │ 16 - 23 │ 2020 │ 2 │ 5 │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 │ 23 - 24 │ 2020 │ 2 │ 5 │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 │ 30 - 25 │ 2020 │ 2 │ 5 │ 31 │ │ │ │ │ │ - 26 │ 2020 │ 2 │ 6 │ │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 - 27 │ 2020 │ 2 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 - 28 │ 2020 │ 2 │ 6 │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 - 29 │ 2020 │ 2 │ 6 │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 - 30 │ 2020 │ 2 │ 6 │ 28 │ 29 │ 30 │ │ │ │ - 31 │ 2020 │ 3 │ 7 │ │ │ │ 1 │ 2 │ 3 │ 4 - 32 │ 2020 │ 3 │ 7 │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 - 33 │ 2020 │ 3 │ 7 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 - 34 │ 2020 │ 3 │ 7 │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 - 35 │ 2020 │ 3 │ 7 │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 │ - 36 │ 2020 │ 3 │ 8 │ │ │ │ │ │ │ 1 - 37 │ 2020 │ 3 │ 8 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 - 38 │ 2020 │ 3 │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 - 39 │ 2020 │ 3 │ 8 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 - 40 │ 2020 │ 3 │ 8 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 - 41 │ 2020 │ 3 │ 8 │ 30 │ 31 │ │ │ │ │ - 42 │ 2020 │ 3 │ 9 │ │ │ 1 │ 2 │ 3 │ 4 │ 5 - 43 │ 2020 │ 3 │ 9 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 - 44 │ 2020 │ 3 │ 9 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 - 45 │ 2020 │ 3 │ 9 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 - 46 │ 2020 │ 3 │ 9 │ 27 │ 28 │ 29 │ 30 │ │ │ - 47 │ 2020 │ 4 │ 10 │ │ │ │ │ 1 │ 2 │ 3 - 48 │ 2020 │ 4 │ 10 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 - 49 │ 2020 │ 4 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 - 50 │ 2020 │ 4 │ 10 │ 18 │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 - 51 │ 2020 │ 4 │ 10 │ 25 │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 - 52 │ 2020 │ 4 │ 11 │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 - 53 │ 2020 │ 4 │ 11 │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 - 54 │ 2020 │ 4 │ 11 │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 - 55 │ 2020 │ 4 │ 11 │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 - 56 │ 2020 │ 4 │ 11 │ 29 │ 30 │ │ │ │ │ - 57 │ 2020 │ 4 │ 12 │ │ │ 1 │ 2 │ 3 │ 4 │ 5 - 58 │ 2020 │ 4 │ 12 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 - 59 │ 2020 │ 4 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 - 60 │ 2020 │ 4 │ 12 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 - 61 │ 2020 │ 4 │ 12 │ 27 │ 28 │ 29 │ 30 │ 31 │ │ -────┴──────┴─────────┴───────┴────────┴────────┴─────────┴───────────┴──────────┴────────┴────────── +> cal --full-year 2012 ``` +This month's calendar with the week starting on monday ```shell -> cal -yqm --full-year 2020 --month-names -────┬──────┬─────────┬───────────┬────────┬────────┬─────────┬───────────┬──────────┬────────┬────────── - # │ year │ quarter │ month │ sunday │ monday │ tuesday │ wednesday │ thursday │ friday │ saturday -────┼──────┼─────────┼───────────┼────────┼────────┼─────────┼───────────┼──────────┼────────┼────────── - 0 │ 2020 │ 1 │ january │ │ │ │ 1 │ 2 │ 3 │ 4 - 1 │ 2020 │ 1 │ january │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 - 2 │ 2020 │ 1 │ january │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 - 3 │ 2020 │ 1 │ january │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 - 4 │ 2020 │ 1 │ january │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 │ - 5 │ 2020 │ 1 │ february │ │ │ │ │ │ │ 1 - 6 │ 2020 │ 1 │ february │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 - 7 │ 2020 │ 1 │ february │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 - 8 │ 2020 │ 1 │ february │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 - 9 │ 2020 │ 1 │ february │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 - 10 │ 2020 │ 1 │ march │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 - 11 │ 2020 │ 1 │ march │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 - 12 │ 2020 │ 1 │ march │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 - 13 │ 2020 │ 1 │ march │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 - 14 │ 2020 │ 1 │ march │ 29 │ 30 │ 31 │ │ │ │ - 15 │ 2020 │ 2 │ april │ │ │ │ 1 │ 2 │ 3 │ 4 - 16 │ 2020 │ 2 │ april │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 - 17 │ 2020 │ 2 │ april │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 - 18 │ 2020 │ 2 │ april │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 - 19 │ 2020 │ 2 │ april │ 26 │ 27 │ 28 │ 29 │ 30 │ │ - 20 │ 2020 │ 2 │ may │ │ │ │ │ │ 1 │ 2 - 21 │ 2020 │ 2 │ may │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 - 22 │ 2020 │ 2 │ may │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 │ 16 - 23 │ 2020 │ 2 │ may │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 │ 23 - 24 │ 2020 │ 2 │ may │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 │ 30 - 25 │ 2020 │ 2 │ may │ 31 │ │ │ │ │ │ - 26 │ 2020 │ 2 │ june │ │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 - 27 │ 2020 │ 2 │ june │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 - 28 │ 2020 │ 2 │ june │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 - 29 │ 2020 │ 2 │ june │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 - 30 │ 2020 │ 2 │ june │ 28 │ 29 │ 30 │ │ │ │ - 31 │ 2020 │ 3 │ july │ │ │ │ 1 │ 2 │ 3 │ 4 - 32 │ 2020 │ 3 │ july │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 - 33 │ 2020 │ 3 │ july │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 - 34 │ 2020 │ 3 │ july │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 - 35 │ 2020 │ 3 │ july │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 │ - 36 │ 2020 │ 3 │ august │ │ │ │ │ │ │ 1 - 37 │ 2020 │ 3 │ august │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 - 38 │ 2020 │ 3 │ august │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 │ 15 - 39 │ 2020 │ 3 │ august │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 │ 22 - 40 │ 2020 │ 3 │ august │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 │ 29 - 41 │ 2020 │ 3 │ august │ 30 │ 31 │ │ │ │ │ - 42 │ 2020 │ 3 │ september │ │ │ 1 │ 2 │ 3 │ 4 │ 5 - 43 │ 2020 │ 3 │ september │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 - 44 │ 2020 │ 3 │ september │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 - 45 │ 2020 │ 3 │ september │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 - 46 │ 2020 │ 3 │ september │ 27 │ 28 │ 29 │ 30 │ │ │ - 47 │ 2020 │ 4 │ october │ │ │ │ │ 1 │ 2 │ 3 - 48 │ 2020 │ 4 │ october │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 10 - 49 │ 2020 │ 4 │ october │ 11 │ 12 │ 13 │ 14 │ 15 │ 16 │ 17 - 50 │ 2020 │ 4 │ october │ 18 │ 19 │ 20 │ 21 │ 22 │ 23 │ 24 - 51 │ 2020 │ 4 │ october │ 25 │ 26 │ 27 │ 28 │ 29 │ 30 │ 31 - 52 │ 2020 │ 4 │ november │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 - 53 │ 2020 │ 4 │ november │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 - 54 │ 2020 │ 4 │ november │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 - 55 │ 2020 │ 4 │ november │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 - 56 │ 2020 │ 4 │ november │ 29 │ 30 │ │ │ │ │ - 57 │ 2020 │ 4 │ december │ │ │ 1 │ 2 │ 3 │ 4 │ 5 - 58 │ 2020 │ 4 │ december │ 6 │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 - 59 │ 2020 │ 4 │ december │ 13 │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 - 60 │ 2020 │ 4 │ december │ 20 │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 - 61 │ 2020 │ 4 │ december │ 27 │ 28 │ 29 │ 30 │ 31 │ │ -────┴──────┴─────────┴───────────┴────────┴────────┴─────────┴───────────┴──────────┴────────┴────────── +> cal --week-start monday ``` -```shell -> cal -ym --full-year 2303 --month-names | where month == "june" -───┬──────┬───────┬────────┬────────┬─────────┬───────────┬──────────┬────────┬────────── - # │ year │ month │ sunday │ monday │ tuesday │ wednesday │ thursday │ friday │ saturday -───┼──────┼───────┼────────┼────────┼─────────┼───────────┼──────────┼────────┼────────── - 0 │ 2303 │ june │ │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 - 1 │ 2303 │ june │ 7 │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 - 2 │ 2303 │ june │ 14 │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 - 3 │ 2303 │ june │ 21 │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 - 4 │ 2303 │ june │ 28 │ 29 │ 30 │ │ │ │ -───┴──────┴───────┴────────┴────────┴─────────┴───────────┴──────────┴────────┴────────── -``` - -```shell -> cal -my --full-year 2020 --month-names | default friday 0 | where friday == 13 -───┬──────┬──────────┬────────┬────────┬─────────┬───────────┬──────────┬────────┬────────── - # │ year │ month │ sunday │ monday │ tuesday │ wednesday │ thursday │ friday │ saturday -───┼──────┼──────────┼────────┼────────┼─────────┼───────────┼──────────┼────────┼────────── - 0 │ 2020 │ march │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 - 1 │ 2020 │ november │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 -───┴──────┴──────────┴────────┴────────┴─────────┴───────────┴──────────┴────────┴────────── -``` - -```shell -> cal -ymq --month-names --week-start monday -───┬──────┬─────────┬───────┬────────┬─────────┬───────────┬──────────┬────────┬──────────┬──────── - # │ year │ quarter │ month │ monday │ tuesday │ wednesday │ thursday │ friday │ saturday │ sunday -───┼──────┼─────────┼───────┼────────┼─────────┼───────────┼──────────┼────────┼──────────┼──────── - 0 │ 2020 │ 2 │ june │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 - 1 │ 2020 │ 2 │ june │ 8 │ 9 │ 10 │ 11 │ 12 │ 13 │ 14 - 2 │ 2020 │ 2 │ june │ 15 │ 16 │ 17 │ 18 │ 19 │ 20 │ 21 - 3 │ 2020 │ 2 │ june │ 22 │ 23 │ 24 │ 25 │ 26 │ 27 │ 28 - 4 │ 2020 │ 2 │ june │ 29 │ 30 │ │ │ │ │ -───┴──────┴─────────┴───────┴────────┴─────────┴───────────┴──────────┴────────┴──────────┴──────── -``` diff --git a/docs/commands/cd.md b/docs/commands/cd.md index 2e5d933f47..dc90e60e29 100644 --- a/docs/commands/cd.md +++ b/docs/commands/cd.md @@ -1,33 +1,16 @@ -# cd +--- +title: cd +layout: command +version: 0.59.0 +--- -If you didn't already know, the `cd` command is very simple. It stands for 'change directory' and it does exactly that. It changes the current directory to the one specified. If no directory is specified, it takes you to the home directory. Additionally, using `cd ..` takes you to the parent directory. +Change directory. -## Examples +## Signature -```shell -/home/username> cd Desktop -/home/username/Desktop> now your current directory has been changed -``` +```> cd (path)``` -```shell -/home/username/Desktop/nested/folders> cd .. -/home/username/Desktop/nested> cd .. -/home/username/Desktop> cd ../Documents/school_related -/home/username/Documents/school_related> cd ../../.. -/home/> -``` +## Parameters -```shell -/home/username/Desktop/super/duper/crazy/nested/folders> cd -/home/username> cd ../../usr -/usr> cd -/home/username> -``` + - `path`: the path to change to -Using `cd -` will take you to the previous directory: - -```shell -/home/username/Desktop/super/duper/crazy/nested/folders> cd -/home/username> cd - -/home/username/Desktop/super/duper/crazy/nested/folders> cd -``` diff --git a/docs/commands/char.md b/docs/commands/char.md index d785b2f61c..023c319d78 100644 --- a/docs/commands/char.md +++ b/docs/commands/char.md @@ -1,38 +1,41 @@ -# char +--- +title: char +layout: command +version: 0.59.0 +--- + Output special characters (e.g., 'newline'). -## Usage -```shell -> char (character) ...args {flags} - ``` +## Signature + +```> char (character) ...rest --list --unicode``` ## Parameters -* `(character)` the name of the character to output -* ...args: multiple Unicode bytes -## Flags -* -h, --help: Display this help message -* -l, --list: List all supported character names -* -u, --unicode: Unicode string i.e. 1f378 + - `character`: the name of the character to output + - `...rest`: multiple Unicode bytes + - `--list`: List all supported character names + - `--unicode`: Unicode string i.e. 1f378 ## Examples - Output newline + +Output newline ```shell > char newline - ``` +``` - Output prompt character, newline and a hamburger character +Output prompt character, newline and a hamburger character ```shell -> echo (char prompt) (char newline) (char hamburger) - ``` +> echo [(char prompt) (char newline) (char hamburger)] | str collect +``` - Output Unicode character +Output Unicode character ```shell > char -u 1f378 - ``` +``` - Output multi-byte Unicode character +Output multi-byte Unicode character ```shell > char -u 1F468 200D 1F466 200D 1F466 - ``` +``` diff --git a/docs/commands/chart-bar.md b/docs/commands/chart-bar.md deleted file mode 100644 index 05ce1d44a5..0000000000 --- a/docs/commands/chart-bar.md +++ /dev/null @@ -1,17 +0,0 @@ -# chart bar -Bar charts - -## Usage -```shell -> chart bar (columns) {flags} - ``` - -## Parameters -* `(columns)` the columns to chart [x-axis y-axis] - -## Flags -* -h, --help: Display this help message -* -a, --acc: accumulate values -* -u, --use : column to use for evaluation -* -f, --format : Specify date and time formatting - diff --git a/docs/commands/chart-line.md b/docs/commands/chart-line.md deleted file mode 100644 index 8daf77d9b2..0000000000 --- a/docs/commands/chart-line.md +++ /dev/null @@ -1,17 +0,0 @@ -# chart line -Line charts - -## Usage -```shell -> chart line (columns) {flags} - ``` - -## Parameters -* `(columns)` the columns to chart [x-axis y-axis] - -## Flags -* -h, --help: Display this help message -* -a, --acc: accumulate values -* -u, --use : column to use for evaluation -* -f, --format : Specify date and time formatting - diff --git a/docs/commands/chart.md b/docs/commands/chart.md deleted file mode 100644 index 2c6f93a8b9..0000000000 --- a/docs/commands/chart.md +++ /dev/null @@ -1,15 +0,0 @@ -# chart -Displays charts. - -## Usage -```shell -> chart {flags} - ``` - -## Subcommands -* chart bar - Bar charts -* chart line - Line charts - -## Flags -* -h, --help: Display this help message - diff --git a/docs/commands/clear.md b/docs/commands/clear.md index 83eb485256..707beba4e6 100644 --- a/docs/commands/clear.md +++ b/docs/commands/clear.md @@ -1,17 +1,19 @@ -# clear -Clears the terminal. +--- +title: clear +layout: command +version: 0.59.0 +--- -## Usage -```shell -> clear {flags} - ``` +Clear the terminal. -## Flags -* -h, --help: Display this help message +## Signature + +```> clear ``` ## Examples - Clear the screen + +Clear the terminal ```shell > clear - ``` +``` diff --git a/docs/commands/clip.md b/docs/commands/clip.md deleted file mode 100644 index e13735d408..0000000000 --- a/docs/commands/clip.md +++ /dev/null @@ -1,22 +0,0 @@ -# clip -Copy the contents of the pipeline to the copy/paste buffer. - -## Usage -```shell -> clip {flags} - ``` - -## Flags -* -h, --help: Display this help message - -## Examples - Save text to the clipboard -```shell -> echo 'secret value' | clip - ``` - - Save numbers to the clipboard -```shell -> random integer 10000000..99999999 | clip - ``` - diff --git a/docs/commands/collect.md b/docs/commands/collect.md new file mode 100644 index 0000000000..55d28ce70d --- /dev/null +++ b/docs/commands/collect.md @@ -0,0 +1,23 @@ +--- +title: collect +layout: command +version: 0.59.0 +--- + +Collect the stream and pass it to a block. + +## Signature + +```> collect (block)``` + +## Parameters + + - `block`: the block to run once the stream is collected + +## Examples + +Use the second value in the stream +```shell +> echo 1 2 3 | collect { |x| echo $x.1 } +``` + diff --git a/docs/commands/columns.md b/docs/commands/columns.md new file mode 100644 index 0000000000..fc10da024a --- /dev/null +++ b/docs/commands/columns.md @@ -0,0 +1,29 @@ +--- +title: columns +layout: command +version: 0.59.0 +--- + +Show the columns in the input. + +## Signature + +```> columns ``` + +## Examples + +Get the columns from the table +```shell +> [[name,age,grade]; [bill,20,a]] | columns +``` + +Get the first column from the table +```shell +> [[name,age,grade]; [bill,20,a]] | columns | first +``` + +Get the second column from the table +```shell +> [[name,age,grade]; [bill,20,a]] | columns | select 1 +``` + diff --git a/docs/commands/compact.md b/docs/commands/compact.md index f31cc790f0..dd022fdc89 100644 --- a/docs/commands/compact.md +++ b/docs/commands/compact.md @@ -1,35 +1,33 @@ -# compact +--- +title: compact +layout: command +version: 0.59.0 +--- -This command allows us to filters out rows with empty columns. Other commands are capable of feeding `compact` with their output through pipelines. +Creates a table with non-empty rows. -## Usage +## Signature -```shell -> [input-command] | compact [column-name] -``` +```> compact ...columns``` + +## Parameters + + - `...columns`: the columns to compact from the table ## Examples -Let's say we have a table like this: - +Filter out all records where 'Hello' is null (returns nothing) ```shell -> open contacts.json -━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━ - # │ name │ email -───┼──────────┼────────────────── - 0 │ paul │ paul@example.com - 1 │ andres │ - 2 │ jonathan │ -━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━ +> echo [["Hello" "World"]; [$nothing 3]]| compact Hello ``` -`compact` allows us to filter out rows with empty `email` column: - +Filter out all records where 'World' is null (Returns the table) ```shell -> open contacts.json | compact email -━━━━━━┯━━━━━━━━━━━━━━━━━━ - name │ email -──────┼────────────────── - paul │ paul@example.com -━━━━━━┷━━━━━━━━━━━━━━━━━━ +> echo [["Hello" "World"]; [$nothing 3]]| compact World ``` + +Filter out all instances of nothing from a list (Returns [1,2] +```shell +> echo [1, $nothing, 2] | compact +``` + diff --git a/docs/commands/config-clear.md b/docs/commands/config-clear.md deleted file mode 100644 index 1709748074..0000000000 --- a/docs/commands/config-clear.md +++ /dev/null @@ -1,17 +0,0 @@ -# config clear -clear the config - -## Usage -```shell -> config clear {flags} - ``` - -## Flags -* -h, --help: Display this help message - -## Examples - Clear the config (be careful!) -```shell -> config clear - ``` - diff --git a/docs/commands/config-get.md b/docs/commands/config-get.md deleted file mode 100644 index 3cec20ba38..0000000000 --- a/docs/commands/config-get.md +++ /dev/null @@ -1,20 +0,0 @@ -# config get -Gets a value from the config - -## Usage -```shell -> config get {flags} - ``` - -## Parameters -* `` value to get from the config - -## Flags -* -h, --help: Display this help message - -## Examples - Get the current startup commands -```shell -> config get startup - ``` - diff --git a/docs/commands/config-path.md b/docs/commands/config-path.md deleted file mode 100644 index 6e720546aa..0000000000 --- a/docs/commands/config-path.md +++ /dev/null @@ -1,17 +0,0 @@ -# config path -return the path to the config file - -## Usage -```shell -> config path {flags} - ``` - -## Flags -* -h, --help: Display this help message - -## Examples - Get the path to the current config file -```shell -> config path - ``` - diff --git a/docs/commands/config-remove.md b/docs/commands/config-remove.md deleted file mode 100644 index da1170cace..0000000000 --- a/docs/commands/config-remove.md +++ /dev/null @@ -1,20 +0,0 @@ -# config remove -Removes a value from the config - -## Usage -```shell -> config remove {flags} - ``` - -## Parameters -* `` remove a value from the config - -## Flags -* -h, --help: Display this help message - -## Examples - Remove the startup commands -```shell -> config remove startup - ``` - diff --git a/docs/commands/config-set.md b/docs/commands/config-set.md deleted file mode 100644 index f1ff89e818..0000000000 --- a/docs/commands/config-set.md +++ /dev/null @@ -1,44 +0,0 @@ -# config set - -Sets a value in the config - -## Usage - -```shell -> config set {flags} -``` - -## Parameters - -- `` variable name to set -- `` value to use - -## Flags - -- -h, --help: Display this help message - -## Examples - -Set auto pivoting - -```shell -> config set pivot_mode always -``` - -Set line editor options - -```shell -> config set line_editor [[edit_mode, completion_type]; [emacs circular]] -``` - -Set coloring options - -```shell -> config set color_config [[header_align header_color]; [left white_bold]] -``` - -Set nested options - -```shell -> config set color_config.header_color white -``` diff --git a/docs/commands/config-set_into.md b/docs/commands/config-set_into.md deleted file mode 100644 index f488052876..0000000000 --- a/docs/commands/config-set_into.md +++ /dev/null @@ -1,20 +0,0 @@ -# config set_into -Sets a value in the config - -## Usage -```shell -> config set_into {flags} - ``` - -## Parameters -* `` sets a variable from values in the pipeline - -## Flags -* -h, --help: Display this help message - -## Examples - Store the contents of the pipeline as a path -```shell -> echo ['/usr/bin' '/bin'] | config set_into path - ``` - diff --git a/docs/commands/config.md b/docs/commands/config.md deleted file mode 100644 index 5375601086..0000000000 --- a/docs/commands/config.md +++ /dev/null @@ -1,53 +0,0 @@ -# config - -Configuration management. - -Syntax: `config {flags}` - -## Flags - - load - load the config from the path give - - set - set a value in the config, eg) set variable value - - set_into - sets a variable from values in the pipeline - - get - get a value from the config - - remove - remove a value from the config - - clear - clear the config - - path - return the path to the config file - -## Variables - -| Variable | Type | Description | -| ------------------ | ---------------------- | ------------------------------------------------------------------------- | -| path | table of strings | PATH to use to find binaries | -| env | row | the environment variables to pass to external commands | -| ctrlc_exit | boolean | whether or not to exit Nu after multiple ctrl-c presses | -| table_mode | "light" or other | enable lightweight or normal tables | -| edit_mode | "vi" or "emacs" | changes line editing to "vi" or "emacs" mode | -| key_timeout | integer (milliseconds) | vi: the delay to wait for a longer key sequence after ESC | -| history_size | integer | maximum entries that will be stored in history (100,000 default) | -| completion_type | "circular" or "list" | changes completion type to "circular" (default) or "list" mode | -| complete_from_path | boolean | whether or not to complete names of binaries on PATH (default true) | -| rm_always_trash | boolean | whether or not to always use system trash when no flags are given to `rm` | -| pivot_mode | "auto" or "always" or "never" | "auto" will only pivot single row tables if the output is greater than the terminal width. "always" will always pivot single row tables. "never" will never pivot single row tables. | -| plugin_dirs | table of strings | additional directories to search for plugins during startup | - -## Examples - -```shell -> config set table_mode "light" -``` - -A more detailed description on how to use this command to configure Nu shell can be found in the configuration chapter of [Nu Book](https://www.nushell.sh/book/en/configuration.html). diff --git a/docs/commands/cp.md b/docs/commands/cp.md index 7e658072ec..8f2ea76830 100644 --- a/docs/commands/cp.md +++ b/docs/commands/cp.md @@ -1,27 +1,18 @@ -# cp +--- +title: cp +layout: command +version: 0.59.0 +--- + Copy files. -## Usage -```shell -> cp {flags} - ``` +## Signature + +```> cp (source) (destination) --recursive``` ## Parameters -* `` the place to copy from -* `` the place to copy to -## Flags -* -h, --help: Display this help message -* -r, --recursive: copy recursively through subdirectories - -## Examples - Copy myfile to dir_b -```shell -> cp myfile dir_b - ``` - - Recursively copy dir_a to dir_b -```shell -> cp -r dir_a dir_b - ``` + - `source`: the place to copy from + - `destination`: the place to copy to + - `--recursive`: copy recursively through subdirectories diff --git a/docs/commands/dataframe.md b/docs/commands/dataframe.md new file mode 100644 index 0000000000..a92966d885 --- /dev/null +++ b/docs/commands/dataframe.md @@ -0,0 +1,12 @@ +--- +title: dataframe +layout: command +version: 0.59.0 +--- + +Deprecated command + +## Signature + +```> dataframe ``` + diff --git a/docs/commands/date-format.md b/docs/commands/date-format.md deleted file mode 100644 index d991881550..0000000000 --- a/docs/commands/date-format.md +++ /dev/null @@ -1,26 +0,0 @@ -# date format -Format a given date using the given format string. - -## Usage -```shell -> date format {flags} - ``` - -## Parameters -* `` strftime format - -## Flags -* -h, --help: Display this help message -* -t, --table: print date in a table - -## Examples - Format the current date -```shell -> date now | date format '%Y.%m.%d_%H %M %S,%z' - ``` - - Format the current date and print in a table -```shell -> date now | date format -t '%Y-%m-%d_%H:%M:%S %z' - ``` - diff --git a/docs/commands/date-humanize.md b/docs/commands/date-humanize.md deleted file mode 100644 index 8be75faaaa..0000000000 --- a/docs/commands/date-humanize.md +++ /dev/null @@ -1,24 +0,0 @@ -# date humanize -Print a 'humanized' format for the date, relative to now. - -## Usage -```shell -> date humanize - ``` - -## Flags -* -h, --help: Display this help message -* -t, --table: print date in a table - -## Examples - Format the current date -```shell -> date now | date humanize - ``` - - Format the current date and print in a table -```shell -> date now | date humanize -t - ``` - - diff --git a/docs/commands/date-list-timezone.md b/docs/commands/date-list-timezone.md deleted file mode 100644 index 9d25161b8f..0000000000 --- a/docs/commands/date-list-timezone.md +++ /dev/null @@ -1,22 +0,0 @@ -# date list-timezone -List supported time zones. - -## Usage -```shell -> date list-timezone {flags} - ``` - -## Flags -* -h, --help: Display this help message - -## Examples - List all supported time zones -```shell -> date list-timezone - ``` - - List all supported European time zones -```shell -> date list-timezone | where timezone =~ Europe - ``` - diff --git a/docs/commands/date-now.md b/docs/commands/date-now.md deleted file mode 100644 index 54b24c5f78..0000000000 --- a/docs/commands/date-now.md +++ /dev/null @@ -1,11 +0,0 @@ -# date now -Get the current date. - -## Usage -```shell -> date now {flags} - ``` - -## Flags -* -h, --help: Display this help message - diff --git a/docs/commands/date-to-table.md b/docs/commands/date-to-table.md deleted file mode 100644 index 268d23163d..0000000000 --- a/docs/commands/date-to-table.md +++ /dev/null @@ -1,17 +0,0 @@ -# date to-table -Print the date in a structured table. - -## Usage -```shell -> date to-table {flags} - ``` - -## Flags -* -h, --help: Display this help message - -## Examples - Print the current date in a table -```shell -> date now | date to-table - ``` - diff --git a/docs/commands/date-to-timezone.md b/docs/commands/date-to-timezone.md deleted file mode 100644 index f33addf37d..0000000000 --- a/docs/commands/date-to-timezone.md +++ /dev/null @@ -1,32 +0,0 @@ -# date to-timezone -Convert a date to a given time zone. - -Use 'date list-timezone' to list all supported time zones. - -## Usage -```shell -> date to-timezone