From 51b8b0538a854da1e0cb3fcc23b55786335fde3d Mon Sep 17 00:00:00 2001 From: Jonathan Turner Date: Mon, 23 Sep 2019 15:55:52 +1200 Subject: [PATCH] Update README.md --- README.md | 56 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 98b1fc10b..22d5d6322 100644 --- a/README.md +++ b/README.md @@ -220,56 +220,57 @@ Nu adheres closely to a set of goals that make up its design philosophy. As feat | ------------- | ------------- | | cd path | Change to a new path | | cp source path | Copy files | +| date (--utc) | Get the current datetime | +| fetch url | Fetch contents from a url and retrieve data as a table if possible | +| help | Display help information about commands | | ls (path) | View the contents of the current or given path | | mkdir path | Make directories, creates intermediary directories as required. | | mv source target | Move files or directories. | -| date (--utc) | Get the current datetime | +| open filename | Load a file into a cell, convert to table if possible (avoid by appending '--raw') | +| post url body (--user ) (--password ) | Post content to a url and retrieve data as a table if possible | | ps | View current processes | | sys | View information about the current system | | which filename | Finds a program file. | -| open filename | Load a file into a cell, convert to table if possible (avoid by appending '--raw') | -| fetch url | Fetch contents from a url and retrieve data as a table if possible | -| post url body (--user ) (--password ) | Post content to a url and retrieve data as a table if possible | | rm {file or directory} | Remove a file, (for removing directory append '--recursive') | +| version | Display Nu version | + +## Shell commands | exit (--now) | Exit the current shell (or all shells) | | enter (path) | Create a new shell and begin at this path | | p | Go to previous shell | | n | Go to next shell | | shells | Display the list of current shells | -| help | Display help information about commands | -| version | Display Nu version | ## Filters on tables (structured data) | command | description | | ------------- | ------------- | -| pick ...columns | Down-select table to only these columns | -| reject ...columns | Remove the given columns from the table | -| get column-or-column-path | Open column and get data from the corresponding cells | -| sort-by ...columns | Sort by the given columns | -| where condition | Filter table to match the condition | -| inc (column-or-column-path) | Increment a value or version. Optionally use the column of a table | | add column-or-column-path value | Add a new column to the table | -| embed column | Creates a new table of one column with the given name, and places the current table inside of it | -| sum | Sum a column of values | | edit column-or-column-path value | Edit an existing column to have a new value | +| embed column | Creates a new table of one column with the given name, and places the current table inside of it | +| first amount | Show only the first number of rows | +| get column-or-column-path | Open column and get data from the corresponding cells | +| inc (column-or-column-path) | Increment a value or version. Optionally use the column of a table | +| last amount | Show only the last number of rows | +| nth row-number | Return only the selected row | +| pick ...columns | Down-select table to only these columns | +| pivot --header-row | Pivot the tables, making columns into rows and vice versa | +| reject ...columns | Remove the given columns from the table | | reverse | Reverses the table. | | skip amount | Skip a number of rows | | skip-while condition | Skips rows while the condition matches. | -| first amount | Show only the first number of rows | -| last amount | Show only the last number of rows | -| nth row-number | Return only the selected row | -| pivot --header-row | Pivot the tables, making columns into rows and vice versa | +| sort-by ...columns | Sort by the given columns | | str (column) | Apply string function. Optionally use the column of a table | +| sum | Sum a column of values | | tags | Read the tags (metadata) for values | -| to-json | Convert table into .json text | -| to-toml | Convert table into .toml text | -| to-yaml | Convert table into .yaml text | -| to-bson | Convert table into .bson text | -| to-csv | Convert table into .csv text | | to-bson | Convert table into .bson binary data | -| to-tsv | Convert table into .tsv text | +| to-csv | Convert table into .csv text | +| to-json | Convert table into .json text | | to-sqlite | Convert table to sqlite .db binary data | +| to-toml | Convert table into .toml text | +| to-tsv | Convert table into .tsv text | | to-url | Convert table to a urlencoded string | +| to-yaml | Convert table into .yaml text | +| where condition | Filter table to match the condition | ## Filters on text (unstructured data) | command | description | @@ -295,12 +296,13 @@ Nu adheres closely to a set of goals that make up its design philosophy. As feat | command | description | | ------------- | ------------- | | autoview | View the contents of the pipeline as a table or list | -| binaryview | Autoview of binary data | -| clip | Copy the contents of the pipeline to the copy/paste buffer | +| binaryview | Autoview of binary data (optional feature) | +| clip | Copy the contents of the pipeline to the copy/paste buffer (optional feature) | | save filename | Save the contents of the pipeline to a file | | table | View the contents of the pipeline as a table | | textview | Autoview of text data | -| tree | View the contents of the pipeline as a tree | +| tree | View the contents of the pipeline as a tree (optional feature) | + # License The project is made available under the MIT license. See "LICENSE" for more information.