extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-01-05 05:50:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve example formatting in README.md (#14695)

Browse Source 
# Description

Conforming the examples in the README documentation to match the new
example formatting suggested in
https://github.com/nushell/nushell.github.io/issues/1684.

# User-Facing Changes

Examples no longer have a prompt indicator, and example results are now
inside of commend blocks. This should improve the ability for users to
test out the examples when exploring nushell for the first time.

# Tests + Formatting

No tests have been added as this is purely a documentation change.
This commit is contained in:
Joshua 2024-12-29 14:02:57 -06:00 committed by GitHub
parent 4ff4e3f93d
commit a65e5ab01d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 56 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
README.md
View File

@ -95,44 +95,44 @@ 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.
```shell ```shell
> ls | where type == "dir" | table ls | where type == "dir" | table
╭────┬──────────┬──────┬─────────┬───────────────╮ # => ╭────┬──────────┬──────┬─────────┬───────────────╮
│ # │ name │ type │ size │ modified │ # => │ # │ name │ type │ size │ modified │
├────┼──────────┼──────┼─────────┼───────────────┤ # => ├────┼──────────┼──────┼─────────┼───────────────┤
│ 0 │ .cargo │ dir │ 0 B │ 9 minutes ago │ # => │ 0 │ .cargo │ dir │ 0 B │ 9 minutes ago │
│ 1 │ assets │ dir │ 0 B │ 2 weeks ago │ # => │ 1 │ assets │ dir │ 0 B │ 2 weeks ago │
│ 2 │ crates │ dir │ 4.0 KiB │ 2 weeks ago │ # => │ 2 │ crates │ dir │ 4.0 KiB │ 2 weeks ago │
│ 3 │ docker │ dir │ 0 B │ 2 weeks ago │ # => │ 3 │ docker │ dir │ 0 B │ 2 weeks ago │
│ 4 │ docs │ dir │ 0 B │ 2 weeks ago │ # => │ 4 │ docs │ dir │ 0 B │ 2 weeks ago │
│ 5 │ images │ dir │ 0 B │ 2 weeks ago │ # => │ 5 │ images │ dir │ 0 B │ 2 weeks ago │
│ 6 │ pkg_mgrs │ dir │ 0 B │ 2 weeks ago │ # => │ 6 │ pkg_mgrs │ dir │ 0 B │ 2 weeks ago │
│ 7 │ samples │ dir │ 0 B │ 2 weeks ago │ # => │ 7 │ samples │ dir │ 0 B │ 2 weeks ago │
│ 8 │ src │ dir │ 4.0 KiB │ 2 weeks ago │ # => │ 8 │ src │ dir │ 4.0 KiB │ 2 weeks ago │
│ 9 │ target │ dir │ 0 B │ a day ago │ # => │ 9 │ target │ dir │ 0 B │ a day ago │
│ 10 │ tests │ dir │ 4.0 KiB │ 2 weeks ago │ # => │ 10 │ tests │ dir │ 4.0 KiB │ 2 weeks ago │
│ 11 │ wix │ dir │ 0 B │ 2 weeks ago │ # => │ 11 │ wix │ dir │ 0 B │ 2 weeks ago │
╰────┴──────────┴──────┴─────────┴───────────────╯ # => ╰────┴──────────┴──────┴─────────┴───────────────╯
``` ```
Because most of the time you'll want to see the output of a pipeline, `table` is assumed. Because most of the time you'll want to see the output of a pipeline, `table` is assumed.
We could have also written the above: We could have also written the above:
```shell ```shell
> ls | where type == "dir" ls | where type == "dir"
``` ```
Being able to use the same commands and compose them differently is an important philosophy in Nu. Being able to use the same commands and compose them differently is an important philosophy in Nu.
For example, we could use the built-in `ps` command to get a list of the running processes, using the same `where` as above. For example, we could use the built-in `ps` command to get a list of the running processes, using the same `where` as above.
```shell ```shell
> ps | where cpu > 0 ps | where cpu > 0
╭───┬───────┬───────────┬───────┬───────────┬───────────╮ # => ╭───┬───────┬───────────┬───────┬───────────┬───────────╮
│ # │ pid │ name │ cpu │ mem │ virtual │ # => │ # │ pid │ name │ cpu │ mem │ virtual │
├───┼───────┼───────────┼───────┼───────────┼───────────┤ # => ├───┼───────┼───────────┼───────┼───────────┼───────────┤
│ 0 │ 2240 │ Slack.exe │ 16.40 │ 178.3 MiB │ 232.6 MiB │ # => │ 0 │ 2240 │ Slack.exe │ 16.40 │ 178.3 MiB │ 232.6 MiB │
│ 1 │ 16948 │ Slack.exe │ 16.32 │ 205.0 MiB │ 197.9 MiB │ # => │ 1 │ 16948 │ Slack.exe │ 16.32 │ 205.0 MiB │ 197.9 MiB │
│ 2 │ 17700 │ nu.exe │ 3.77 │ 26.1 MiB │ 8.8 MiB │ # => │ 2 │ 17700 │ nu.exe │ 3.77 │ 26.1 MiB │ 8.8 MiB │
╰───┴───────┴───────────┴───────┴───────────┴───────────╯ # => ╰───┴───────┴───────────┴───────┴───────────┴───────────╯
``` ```
### Opening files ### Opening files
@ -141,46 +141,46 @@ Nu can load file and URL contents as raw text or structured data (if it recogniz
For example, you can load a .toml file as structured data and explore it: For example, you can load a .toml file as structured data and explore it:
```shell ```shell
> open Cargo.toml open Cargo.toml
╭──────────────────┬────────────────────╮ # => ╭──────────────────┬────────────────────╮
│ bin │ [table 1 row] │ # => │ bin │ [table 1 row] │
│ dependencies │ {record 25 fields} │ # => │ dependencies │ {record 25 fields} │
│ dev-dependencies │ {record 8 fields} │ # => │ dev-dependencies │ {record 8 fields} │
│ features │ {record 10 fields} │ # => │ features │ {record 10 fields} │
│ package │ {record 13 fields} │ # => │ package │ {record 13 fields} │
│ patch │ {record 1 field} │ # => │ patch │ {record 1 field} │
│ profile │ {record 3 fields} │ # => │ profile │ {record 3 fields} │
│ target │ {record 3 fields} │ # => │ target │ {record 3 fields} │
│ workspace │ {record 1 field} │ # => │ workspace │ {record 1 field} │
╰──────────────────┴────────────────────╯ # => ╰──────────────────┴────────────────────╯
``` ```
We can pipe this into a command that gets the contents of one of the columns: We can pipe this into a command that gets the contents of one of the columns:
```shell ```shell
> open Cargo.toml | get package open Cargo.toml | get package
╭───────────────┬────────────────────────────────────╮ # => ╭───────────────┬────────────────────────────────────╮
│ authors │ [list 1 item] │ # => │ authors │ [list 1 item] │
│ default-run │ nu │ # => │ default-run │ nu │
│ description │ A new type of shell │ # => │ description │ A new type of shell │
│ documentation │ https://www.nushell.sh/book/ │ # => │ documentation │ https://www.nushell.sh/book/ │
│ edition │ 2018 │ # => │ edition │ 2018 │
│ exclude │ [list 1 item] │ # => │ exclude │ [list 1 item] │
│ homepage │ https://www.nushell.sh │ # => │ homepage │ https://www.nushell.sh │
│ license │ MIT │ # => │ license │ MIT │
│ metadata │ {record 1 field} │ # => │ metadata │ {record 1 field} │
│ name │ nu │ # => │ name │ nu │
│ repository │ https://github.com/nushell/nushell │ # => │ repository │ https://github.com/nushell/nushell │
│ rust-version │ 1.60 │ # => │ rust-version │ 1.60 │
│ version │ 0.72.0 │ # => │ version │ 0.72.0 │
╰───────────────┴────────────────────────────────────╯ # => ╰───────────────┴────────────────────────────────────╯
``` ```
And if needed we can drill down further: And if needed we can drill down further:
```shell ```shell
> open Cargo.toml | get package.version open Cargo.toml | get package.version
0.72.0 # => 0.72.0
``` ```
### Plugins ### Plugins