Skip to content

docs: clarify multiline command continuations #1477

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

Open
KirtiRamchandani wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: clarify multiline command continuations #1477

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,18 @@ const flags = [
await $`git log ${flags}`
```

For a long command, use the shell's line-continuation syntax. Keep the
backslash as the final character on each continued line; trailing spaces after
the backslash make the shell treat the next line as a separate command.

```js
const preview = 'cat {2}'

await $`fzf \
--preview=${preview} \
--with-nth=1`
```

In async mode, zx awaits any `thenable` in literal before executing the command.
```js
const a1 = $`echo foo`
Expand Down