Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add pipeline examples #1748

Merged
merged 5 commits into from
Jan 15, 2025
Merged

add pipeline examples #1748

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9abe7ae
add pipeline examples
WindSoilder Jan 14, 2025
3bf3028
Update lang-guide/chapters/pipelines.md
WindSoilder Jan 14, 2025
d9188b3
Update lang-guide/chapters/pipelines.md
WindSoilder Jan 14, 2025
202fdc1
Update lang-guide/chapters/pipelines.md
WindSoilder Jan 14, 2025
d8131fe
update example
WindSoilder Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 146 additions & 0 deletions lang-guide/chapters/pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,149 @@ nu demo.nu o> file.txt o+e>| str upcase
```

Also note that `complete` is special, it doesn't work with `e>|`, `o+e>|`.

## Stdio and redirection behavior examples

Pipeline and redirection behavior can be hard to follow when they are used with subexpression, or custom commands. Here are some examples to show stdio behavior
WindSoilder marked this conversation as resolved.
Show resolved Hide resolved

### Examples for subexpression

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4)

| Command | Stdout | Stderr |
| ------- | -------- | ---------- |
| cmd1 | Piped | Terminal |
| cmd2 | *Terminal* | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Terminal | Terminal |

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4) | ^cmd5
WindSoilder marked this conversation as resolved.
Show resolved Hide resolved

| Command | Stdout | Stderr |
| ------- | -------- | ---------- |
| cmd1 | Piped | Terminal |
| cmd2 | *Terminal* | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Piped | Terminal |

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4) e>| ^cmd5

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | Terminal |
| cmd2 | Terminal | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Terminal | Piped |

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4) o+e>| ^cmd5

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | Terminal |
| cmd2 | Terminal | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Piped | Piped |

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4) o> test.out

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | Terminal |
| cmd2 | File | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | File | Terminal |

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4) e> test.out

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | File |
| cmd2 | Terminal | File |
| cmd3 | Piped | File |
| cmd4 | Terminal | File |

- (^cmd1 | ^cmd2; ^cmd3 | ^cmd4) o+e> test.out

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | File |
| cmd2 | File | File |
| cmd3 | Piped | File |
| cmd4 | File | File |

### Examples for custom command
Given the following custom commands

```nushell
def custom-cmd [] {
^cmd1 | ^cmd2
^cmd3 | ^cmd4
}
```

Here are some examples to show stdio behavior. Actually the stio behavior will be the same to previous session.
WindSoilder marked this conversation as resolved.
Show resolved Hide resolved

You can think the body of `custom-cmd` like `(^cmd1 | ^cmd2; ^cmd3 | ^cmd4).
WindSoilder marked this conversation as resolved.
Show resolved Hide resolved

- custom-cmd

| Command | Stdout | Stderr |
| ------- | -------- | ---------- |
| cmd1 | Piped | Terminal |
| cmd2 | *Terminal* | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Terminal | Terminal |

- custom-cmd | ^cmd5

| Command | Stdout | Stderr |
| ------- | -------- | ---------- |
| cmd1 | Piped | Terminal |
| cmd2 | *Terminal* | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Piped | Terminal |

- custom-cmd e>| ^cmd5

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | Terminal |
| cmd2 | Terminal | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Terminal | Piped |

- custom-cmd o+e>| ^cmd5

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | Terminal |
| cmd2 | Terminal | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | Piped | Piped |

- custom-cmd o> test.out

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | Terminal |
| cmd2 | File | Terminal |
| cmd3 | Piped | Terminal |
| cmd4 | File | Terminal |

- custom-cmd e> test.out

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | File |
| cmd2 | Terminal | File |
| cmd3 | Piped | File |
| cmd4 | Terminal | File |

- custom-cmd o+e> test.out

| Command | Stdout | Stderr |
| ------- | -------- | -------- |
| cmd1 | Piped | File |
| cmd2 | File | File |
| cmd3 | Piped | File |
| cmd4 | File | File |
Loading