From 34b5e5c34eda89f94e426b05be020cf95ef174a3 Mon Sep 17 00:00:00 2001 From: Bruno Heridet Date: Wed, 13 May 2020 10:03:29 +0200 Subject: [PATCH] doc: add headers command page (#1775) --- docs/commands/headers.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/commands/headers.md diff --git a/docs/commands/headers.md b/docs/commands/headers.md new file mode 100644 index 0000000000..59f3578a35 --- /dev/null +++ b/docs/commands/headers.md @@ -0,0 +1,23 @@ +# headers + +Use `headers` to turn the first row of a table into meaningful column names. + +As demonstrated in the following example, it's particularly handy when working with spreadsheets. + +## Examples + +```shell +❯ open sample_data.ods | get SalesOrders +────┬────────────┬─────────┬──────────┬─────────┬─────────┬───────────┬─────────── + # │ Column0 │ Column1 │ Column2 │ Column3 │ Column4 │ Column5 │ Column6 +────┼────────────┼─────────┼──────────┼─────────┼─────────┼───────────┼─────────── + 0 │ OrderDate │ Region │ Rep │ Item │ Units │ Unit Cost │ Total + 1 │ 2018-01-06 │ East │ Jones │ Pencil │ 95.0000 │ 1.9900 │ 189.0500 + +❯ open sample_data.ods | get SalesOrders | headers +────┬────────────┬─────────┬──────────┬─────────┬─────────┬───────────┬─────────── + # │ OrderDate │ Region │ Rep │ Item │ Units │ Unit Cost │ Total +────┼────────────┼─────────┼──────────┼─────────┼─────────┼───────────┼─────────── + 0 │ 2018-01-06 │ East │ Jones │ Pencil │ 95.0000 │ 1.9900 │ 189.0500 + 1 │ 2018-01-23 │ Central │ Kivell │ Binder │ 50.0000 │ 19.9900 │ 999.4999 +```