Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-12-28 14:03:09 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README examples (#1779)

Browse source
This commit is contained in:
Jonathan Turner 2020-05-13 10:36:24 -07:00 committed by GitHub
parent 6826a9aeac
commit 8abbfd3ec9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 49 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
README.md
View file

@ -144,19 +144,20 @@ Commands that work in the pipeline fit into one of three categories:
Commands are separated by the pipe symbol (`|`) to denote a pipeline flowing left to right. Commands are separated by the pipe symbol (`|`) to denote a pipeline flowing left to right.
``` ```
/home/jonathan/Source/nushell(master)> ls | where type == "Directory" | autoview /home/jonathan/Source/nushell(master)ls | where type == "Dir" | autoview
────┬───────────┬───────────┬──────────┬────────┬──────────────┬──────────────── ───┬────────┬──────┬────────┬──────────────
# │ name │ type │ readonly │ size │ accessed │ modified # │ name │ type │ size │ modified
────┼───────────┼───────────┼──────────┼────────┼──────────────┼──────────────── ───┼────────┼──────┼────────┼──────────────
0 │ .azure │ Directory │ │ 4.1 KB │ 2 months ago │ a day ago 0 │ assets │ Dir │ 4.1 KB │ 1 week ago
1 │ target │ Directory │ │ 4.1 KB │ 3 days ago │ 3 days ago 1 │ crates │ Dir │ 4.1 KB │ 4 days ago
2 │ images │ Directory │ │ 4.1 KB │ 2 months ago │ 2 weeks ago 2 │ debian │ Dir │ 4.1 KB │ 1 week ago
3 │ tests │ Directory │ │ 4.1 KB │ 2 months ago │ 37 minutes ago 3 │ docker │ Dir │ 4.1 KB │ 1 week ago
4 │ tmp │ Directory │ │ 4.1 KB │ 2 weeks ago │ 2 weeks ago 4 │ docs │ Dir │ 4.1 KB │ 1 week ago
5 │ src │ Directory │ │ 4.1 KB │ 2 months ago │ 37 minutes ago 5 │ images │ Dir │ 4.1 KB │ 1 week ago
6 │ assets │ Directory │ │ 4.1 KB │ a month ago │ a month ago 6 │ src │ Dir │ 4.1 KB │ 1 week ago
7 │ docs │ Directory │ │ 4.1 KB │ 2 months ago │ 2 months ago 7 │ target │ Dir │ 4.1 KB │ 23 hours ago
────┴───────────┴───────────┴──────────┴────────┴──────────────┴──────────────── 8 │ tests │ Dir │ 4.1 KB │ 1 week ago
───┴────────┴──────┴────────┴──────────────
``` ```
Because most of the time you'll want to see the output of a pipeline, `autoview` is assumed. Because most of the time you'll want to see the output of a pipeline, `autoview` is assumed.
@ -170,15 +171,16 @@ Being able to use the same commands and compose them differently is an important
For example, we could use the built-in `ps` command as well to get a list of the running processes, using the same `where` as above. For example, we could use the built-in `ps` command as well to get a list of the running processes, using the same `where` as above.
```text ```text
/home/jonathan/Source/nushell(master)> ps | where cpu > 0 /home/jonathan/Source/nushell(master)ps | where cpu > 0
───┬───────┬─────────────────┬──────────┬────────── ───┬────────┬───────────────────┬──────────┬─────────┬──────────┬──────────
# │ pid │ name │ status │ cpu # │ pid │ name │ status │ cpu │ mem │ virtual
───┼───────┼─────────────────┼──────────┼────────── ───┼────────┼───────────────────┼──────────┼─────────┼──────────┼──────────
0 │ 992 │ chrome │ Sleeping │ 6.988768 0 │ 435 │ irq/142-SYNA327 │ Sleeping │ 7.5699 │ 0 B │ 0 B
1 │ 4240 │ chrome │ Sleeping │ 5.645982 1 │ 1609 │ pulseaudio │ Sleeping │ 6.5605 │ 10.6 MB │ 2.3 GB
2 │ 13973 │ qemu-system-x86 │ Sleeping │ 4.996551 2 │ 1625 │ gnome-shell │ Sleeping │ 6.5684 │ 639.6 MB │ 7.3 GB
3 │ 15746 │ nu │ Sleeping │ 84.59905 3 │ 2202 │ Web Content │ Sleeping │ 6.8157 │ 320.8 MB │ 3.0 GB
───┴───────┴─────────────────┴──────────┴────────── 4 │ 328788 │ nu_plugin_core_ps │ Sleeping │ 92.5750 │ 5.9 MB │ 633.2 MB
───┴────────┴───────────────────┴──────────┴─────────┴──────────┴──────────
``` ```
## Opening files ## Opening files
@ -188,45 +190,49 @@ For example, you can load a .toml file as structured data and explore it:
``` ```
/home/jonathan/Source/nushell(master)> open Cargo.toml /home/jonathan/Source/nushell(master)> open Cargo.toml
──────────────────┬────────────────┬────────────────── ────────────────────┬───────────────────────────
bin │ dependencies │ dev-dependencies bin │ [table 18 rows]
──────────────────┼────────────────┼────────────────── build-dependencies │ [row nu-build serde toml]
[table: 12 rows] │ [table: 1 row] │ [table: 1 row] dependencies │ [row 29 columns]
──────────────────┴────────────────┴────────────────── dev-dependencies │ [row nu-test-support]
features │ [row 19 columns]
package │ [row 12 columns]
workspace │ [row members]
────────────────────┴───────────────────────────
``` ```
We can pipeline this into a command that gets the contents of one of the columns: We can pipeline this into a command that gets the contents of one of the columns:
``` ```
/home/jonathan/Source/nushell(master)> open Cargo.toml | get package /home/jonathan/Source/nushell(master)> open Cargo.toml | get package
─────────────────┬────────────────────────────┬─────────┬─────────┬──────┬───────── ───────────────┬────────────────────────────────────
authors │ description │ edition │ license │ name │ version authors │ [table 1 rows]
─────────────────┼────────────────────────────┼─────────┼─────────┼──────┼───────── default-run │ nu
[table: 3 rows] │ A shell for the GitHub era │ 2018 │ MIT │ nu │ 0.9.0 description │ A new type of shell
─────────────────┴────────────────────────────┴─────────┴─────────┴──────┴───────── documentation │ https://www.nushell.sh/book/
edition │ 2018
exclude │ [table 1 rows]
homepage │ https://www.nushell.sh
license │ MIT
name │ nu
readme │ README.md
repository │ https://github.com/nushell/nushell
version │ 0.14.1
───────────────┴────────────────────────────────────
``` ```
Finally, we can use commands outside of Nu once we have the data we want: Finally, we can use commands outside of Nu once we have the data we want:
``` ```
/home/jonathan/Source/nushell(master)> open Cargo.toml | get package.version | echo $it /home/jonathan/Source/nushell(master)> open Cargo.toml | get package.version | echo $it
0.9.0 0.14.1
``` ```
Here we use the variable `$it` to refer to the value being piped to the external command. Here we use the variable `$it` to refer to the value being piped to the external command.
## Configuration ## Configuration
Nu has early support for configuring the shell. It currently supports the following settings: Nu has early support for configuring the shell. You can refer to the book for a list of [all supported variables](https://www.nushell.sh/book/en/configuration.html).
| 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 |
| completion_mode | "circular" or "list" | changes completion type to "circular" (default) or "list" mode |
To set one of these variables, you can use `config --set`. For example: To set one of these variables, you can use `config --set`. For example: