https://github.com/google/zx

A tool for writing better scripts
https://github.com/google/zx

bash cli javascript nodejs shell

Last synced: about 2 months ago
JSON representation

A tool for writing better scripts

• Host: GitHub
• URL: https://github.com/google/zx
• Owner: google
• License: apache-2.0
• Created: 2021-05-05T05:50:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T18:55:11.000Z (4 months ago)
• Last Synced: 2024-05-29T01:01:14.012Z (4 months ago)
• Topics: bash, cli, javascript, nodejs, shell
• Language: JavaScript
• Homepage: https://google.github.io/zx/
• Size: 1.5 MB
• Stars: 42,040
• Watchers: 154
• Forks: 1,067
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: docs/code-of-conduct.md

Awesome Lists containing this project

• awesome - google/zx - A tool for writing better scripts (JavaScript)
• stars - google/zx
• my-awesome-list - zx
• awesome-nodejs - zx - A tool for writing better scripts.  (Repository / Shell)
• awesome-nodejs-cn - zx - **star:42187** 编写shell脚本JavaScript。 ![star > 2000][Awesome] (包 / 命令行实用工具)
• awesome-github-repos - google/zx - A tool for writing better scripts (JavaScript)
• awesome-rainmana - google/zx - A tool for writing better scripts (JavaScript)
• awesome-repositories - google/zx - A tool for writing better scripts (JavaScript)
• awesome-github-star - zx
• awesome-starred - google/zx - A tool for writing better scripts (nodejs)
• stars - google/zx - A tool for writing better scripts (JavaScript)
• awesome-list - zx
• awesome-nodejs - zx - Write shell scripts JavaScript. (Packages / Command-line utilities)
• Awesome - `zx` (A tool for writing better scripts)
• StarryDivineSky - google/zx
• awesome-star-libs - google / zx
• awesome-nodejs - zx - 用于编写更好 bash 脚本的工具(Node.js >= 14.13.1)。  (GIT 仓库 / 脚本执行)

README

        


 zx


```js

#!/usr/bin/env zx

await $`cat package.json | grep name`

let 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`,

])

let 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

```bash

npm install zx

```

## Documentation

Read documentation on [google.github.io/zx](https://google.github.io/zx/).

## License

[Apache-2.0](LICENSE)

Disclaimer: _This is not an officially supported Google product._