zx

google
esm cjs
zx JS library homepage zx JS library on GitHub zx JS library on npm Download zx JS library

A tool for writing better scripts

Version 8.5.0 License Apache-2.0
zx JS library homepage
zx JS library on GitHub
zx JS library on npm
Download zx JS library
Keywords
shellscriptbashbinbinarychildprocessexecexecuteinvokecallspawn
INSTALL
Type:
Version:
<script type="module"> import zx from 'https://cdn.jsdelivr.net/npm/zx@8.5.0/+esm' </script>
Learn more

Zx logo zx

#!/usr/bin/env zx

await $`cat package.json | grep name`

const branch = await $`git branch --show-current`
await $`dep deploy --branch=${branch}`

await Promise.all([
  $`sleep 1; echo 1`,
  $`sleep 2; echo 2`,
  $`sleep 3; echo 3`,
])

const name = 'foo bar'
await $`mkdir /tmp/${name}`

Bash is great, but when it comes to writing more complex scripts, many people prefer a more convenient programming language. JavaScript is a perfect choice, but the Node.js standard library requires additional hassle before using. The zx package provides useful wrappers around child_process, escapes arguments and gives sensible defaults.

Install

npm install zx

Documentation

Read documentation on google.github.io/zx.

License

Apache-2.0

Disclaimer: This is not an officially supported Google product.