diff --git a/docs/commands/compact.md b/docs/commands/compact.md new file mode 100644 index 0000000000..8399942e11 --- /dev/null +++ b/docs/commands/compact.md @@ -0,0 +1,34 @@ +# compact + +This command allows us to filters out rows with empty columns. Other commands are capable of feeding `compact` with their output through pipelines. + +## Usage +```shell +> [input-command] | compact [column-name] +``` + +## Examples + +Let's say we have a table like this: + +```shell +> open contacts.json +━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━ + # │ name │ email +───┼──────────┼────────────────── + 0 │ paul │ paul@example.com + 1 │ andres │ + 2 │ jonathan │ +━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━ +``` + +`compact` allows us to filter out rows with empty `email` column: + +```shell +> open contacts.json | compact email +━━━━━━┯━━━━━━━━━━━━━━━━━━ + name │ email +──────┼────────────────── + paul │ paul@example.com +━━━━━━┷━━━━━━━━━━━━━━━━━━ +``` diff --git a/docs/commands/default.md b/docs/commands/default.md new file mode 100644 index 0000000000..b08c6d3443 --- /dev/null +++ b/docs/commands/default.md @@ -0,0 +1,36 @@ +# default + +This command sets a default row's column if missing. Other commands are capable of feeding `default` with their output through pipelines. + +## Usage +```shell +> [input-command] | default [column-name] [column-value] +``` + +## Examples + +Let's say we have a table like this: + +```shell +> open contacts.json +━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━ + # │ name │ email +───┼──────────┼────────────────── + 0 │ paul │ paul@example.com + 1 │ andres │ + 2 │ jonathan │ +━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━ +``` + +`default` allows us to fill `email` column with a default value: + +```shell +> open contacts.json | default email "no-reply@example.com" +━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━ + # │ name │ email +───┼──────────┼────────────────────── + 0 │ paul │ paul@example.com + 1 │ andres │ no-reply@example.com + 2 │ jonathan │ no-reply@example.com +━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━ +```